From 5685fc279692ff1df11a5ac5535be8d42c6af43f Mon Sep 17 00:00:00 2001 From: Luke Hagar Date: Wed, 1 Oct 2025 19:33:18 +0000 Subject: [PATCH] Prettier formatting --- .prettierignore | 10 + .prettierrc | 11 + 2.0/2.0.md | 788 +-- 2.0/data-types/array.ts | 110 +- 2.0/data-types/boolean.ts | 180 +- 2.0/data-types/file.ts | 182 +- 2.0/data-types/integer.ts | 268 +- 2.0/data-types/object.ts | 174 +- 2.0/data-types/string.ts | 258 +- 2.0/example.ts | 26 +- 2.0/extensions.ts | 32 +- 2.0/externalDocs.ts | 62 +- 2.0/index.ts | 80 +- 2.0/info.ts | 200 +- 2.0/paths.ts | 1398 ++-- 2.0/references.ts | 36 +- 2.0/schema.ts | 30 +- 2.0/security.ts | 226 +- 2.0/spec.ts | 314 +- 2.0/status.ts | 1842 +++--- 2.0/tags.ts | 80 +- 2.0/xml.ts | 94 +- 3.0/3.0.0.md | 1267 ++-- 3.0/3.0.1.md | 1214 ++-- 3.0/3.0.2.md | 1293 ++-- 3.0/3.0.3.md | 1284 ++-- 3.0/3.0.4.md | 884 +-- 3.0/components.ts | 280 +- 3.0/data-types/array.ts | 206 +- 3.0/data-types/boolean.ts | 146 +- 3.0/data-types/composition.ts | 202 +- 3.0/data-types/integer.ts | 238 +- 3.0/data-types/number.ts | 238 +- 3.0/data-types/object.ts | 264 +- 3.0/data-types/reference.ts | 30 +- 3.0/data-types/string.ts | 480 +- 3.0/extensions.ts | 2 +- 3.0/externalDocs.ts | 64 +- 3.0/index.ts | 72 +- 3.0/info.ts | 718 +-- 3.0/paths.ts | 2504 ++++---- 3.0/references.ts | 34 +- 3.0/schema.ts | 98 +- 3.0/security.ts | 508 +- 3.0/servers.ts | 206 +- 3.0/spec.ts | 284 +- 3.0/status.ts | 1970 +++--- 3.0/tags.ts | 96 +- 3.0/xml.ts | 172 +- 3.1/3.1.0.md | 1301 ++-- 3.1/3.1.1.md | 860 +-- 3.1/components.ts | 136 +- 3.1/data-types/array.ts | 234 +- 3.1/data-types/boolean.ts | 122 +- 3.1/data-types/composition.ts | 210 +- 3.1/data-types/integer.ts | 206 +- 3.1/data-types/null.ts | 84 +- 3.1/data-types/number.ts | 206 +- 3.1/data-types/object.ts | 252 +- 3.1/data-types/reference.ts | 28 +- 3.1/data-types/string.ts | 206 +- 3.1/extensions.ts | 18 +- 3.1/externalDocs.ts | 32 +- 3.1/index.ts | 47 +- 3.1/info.ts | 186 +- 3.1/paths.ts | 1208 ++-- 3.1/references.ts | 50 +- 3.1/schema.ts | 64 +- 3.1/security.ts | 258 +- 3.1/servers.ts | 106 +- 3.1/spec.ts | 156 +- 3.1/status.ts | 1970 +++--- 3.1/tags.ts | 42 +- 3.1/xml.ts | 88 +- 3.2/3.2.0.md | 1424 ++-- 3.2/components.ts | 1432 ++--- 3.2/data-types/array.ts | 222 +- 3.2/data-types/boolean.ts | 110 +- 3.2/data-types/composition.ts | 198 +- 3.2/data-types/integer.ts | 194 +- 3.2/data-types/number.ts | 194 +- 3.2/data-types/object.ts | 240 +- 3.2/data-types/reference.ts | 28 +- 3.2/data-types/string.ts | 166 +- 3.2/extensions.ts | 18 +- 3.2/externalDocs.ts | 32 +- 3.2/index.ts | 16 +- 3.2/info.ts | 324 +- 3.2/oauth.ts | 140 +- 3.2/paths.ts | 942 +-- 3.2/references.ts | 50 +- 3.2/schema.ts | 60 +- 3.2/servers.ts | 164 +- 3.2/spec.ts | 274 +- 3.2/status.ts | 1970 +++--- 3.2/tags.ts | 42 +- 3.2/xml.ts | 88 +- License.ts | 17 +- README.md | 157 +- SPDXLicenseList.ts | 6796 ++++++++++---------- build.ts | 38 +- bun.lock | 7 +- package.json | 3 + schemas/2.0/components/parameter.json | 974 +-- schemas/2.0/components/pathitem.json | 974 +-- schemas/2.0/components/response.json | 978 +-- schemas/2.0/components/schema.json | 974 +-- schemas/2.0/index.ts | 1 - schemas/2.0/main/specification.json | 1032 +-- schemas/3.0/components/callback.json | 897 +-- schemas/3.0/components/example.json | 902 +-- schemas/3.0/components/header.json | 931 +-- schemas/3.0/components/link.json | 907 +-- schemas/3.0/components/parameter.json | 957 +-- schemas/3.0/components/pathitem.json | 4780 ++++++++++++++ schemas/3.0/components/requestbody.json | 910 +-- schemas/3.0/components/response.json | 901 +-- schemas/3.0/components/schema.json | 897 +-- schemas/3.0/components/securityscheme.json | 951 +-- schemas/3.0/index.ts | 1 - schemas/3.0/main/specification.json | 916 +-- schemas/3.1/components/callback.json | 700 +- schemas/3.1/components/example.json | 711 +- schemas/3.1/components/header.json | 746 +-- schemas/3.1/components/link.json | 716 +-- schemas/3.1/components/parameter.json | 761 +-- schemas/3.1/components/pathitem.json | 716 +-- schemas/3.1/components/requestbody.json | 720 +-- schemas/3.1/components/response.json | 710 +- schemas/3.1/components/schema.json | 700 +- schemas/3.1/components/securityscheme.json | 764 +-- schemas/3.1/index.ts | 1 - schemas/3.1/main/specification.json | 720 +-- schemas/3.2/components/callback.json | 647 +- schemas/3.2/components/example.json | 658 +- schemas/3.2/components/header.json | 692 +- schemas/3.2/components/link.json | 663 +- schemas/3.2/components/mediatype.json | 653 +- schemas/3.2/components/parameter.json | 713 +- schemas/3.2/components/pathitem.json | 663 +- schemas/3.2/components/requestbody.json | 667 +- schemas/3.2/components/response.json | 662 +- schemas/3.2/components/schema.json | 647 +- schemas/3.2/components/securityscheme.json | 708 +- schemas/3.2/index.ts | 1 - schemas/3.2/main/specification.json | 666 +- tests/2.0/api-with-examples.ts | 286 +- tests/2.0/petstore-expanded.ts | 396 +- tests/2.0/petstore-minimal.ts | 113 +- tests/2.0/petstore-simple.ts | 405 +- tests/2.0/petstore-with-external-docs.ts | 427 +- tests/2.0/petstore.ts | 266 +- tests/2.0/uber.ts | 732 ++- tests/3.0/api-with-examples.ts | 380 +- tests/3.0/callback-example.ts | 167 +- tests/3.0/link-example.ts | 634 +- tests/3.0/petstore-expanded.ts | 472 +- tests/3.0/petstore.ts | 350 +- tests/3.0/uspto.ts | 502 +- tests/3.1/non-oauth-scopes.ts | 59 +- tests/3.1/tictactoe.ts | 523 +- tests/3.1/webhook-example.ts | 91 +- tests/openapi-3.0-schemas.test.ts | 58 +- tests/openapi-3.1-schemas.test.ts | 82 +- tests/swagger-schemas.test.ts | 41 +- tsconfig.json | 52 +- 166 files changed, 35810 insertions(+), 49685 deletions(-) create mode 100644 .prettierignore create mode 100644 .prettierrc create mode 100644 schemas/3.0/components/pathitem.json diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 0000000..af0afe1 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,10 @@ +node_modules/ +dist/ +build/ +coverage/ +*.min.js +*.min.css +pnpm-lock.yaml +bun.lock +package-lock.json +yarn.lock diff --git a/.prettierrc b/.prettierrc new file mode 100644 index 0000000..49937ec --- /dev/null +++ b/.prettierrc @@ -0,0 +1,11 @@ +{ + "semi": true, + "trailingComma": "es5", + "singleQuote": false, + "printWidth": 100, + "tabWidth": 2, + "useTabs": false, + "bracketSpacing": true, + "arrowParens": "avoid", + "endOfLine": "lf" +} diff --git a/2.0/2.0.md b/2.0/2.0.md index bc4a36d..ac72bcc 100644 --- a/2.0/2.0.md +++ b/2.0/2.0.md @@ -1,4 +1,5 @@ # OpenAPI Specification + ## (fka Swagger RESTful API Documentation Specification) #### Version 2.0 @@ -9,28 +10,31 @@ The Swagger specification is licensed under [The Apache License, Version 2.0](ht ## Introductions -Swagger™ is a project used to describe and document RESTful APIs. +Swagger™ is a project used to describe and document RESTful APIs. The Swagger specification defines a set of files required to describe such an API. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools. ## Revision History -Version | Date | Notes ---- | --- | --- -2.0 | 2014-09-08 | Release of Swagger 2.0 -1.2 | 2014-03-14 | Initial release of the formal document. -1.1 | 2012-08-22 | Release of Swagger 1.1 -1.0 | 2011-08-10 | First release of the Swagger Specification +| Version | Date | Notes | +| ------- | ---------- | ------------------------------------------ | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | ## Definitions ##### Path Templating + Path templating refers to the usage of curly braces ({}) to mark a section of a URL path as replaceable using path parameters. ##### Mime Types + Mime type definitions are spread across several resources. The mime type definitions should be in compliance with [RFC 6838](http://tools.ietf.org/html/rfc6838). Some examples of possible mime type definitions: + ``` text/plain; charset=utf-8 application/json @@ -43,7 +47,9 @@ Some examples of possible mime type definitions: application/vnd.github.v3.diff application/vnd.github.v3.patch ``` + ##### HTTP Status Codes + The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are described by [RFC 7231](http://tools.ietf.org/html/rfc7231#section-6) and in the [IANA Status Code Registry](http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). ## Specification @@ -81,20 +87,19 @@ An additional primitive data type `"file"` is used by the [Parameter Object](#pa Primitives have an optional modifier property `format`. Swagger uses several known formats to more finely define the data type being used. However, the `format` property is an open `string`-valued property, and can have any value to support documentation needs. Formats such as `"email"`, `"uuid"`, etc., can be used even though they are not defined by this specification. Types that are not accompanied by a `format` property follow their definition from the JSON Schema (except for `file` type which is defined above). The formats defined by the Swagger Specification are: - -Common Name | [`type`](#dataTypeType) | [`format`](#dataTypeFormat) | Comments ------------ | ------ | -------- | -------- -integer | `integer` | `int32` | signed 32 bits -long | `integer` | `int64` | signed 64 bits -float | `number` | `float` | | -double | `number` | `double` | | -string | `string` | | | -byte | `string` | `byte` | base64 encoded characters -binary | `string` | `binary` | any sequence of octets -boolean | `boolean` | | | -date | `string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -password | `string` | `password` | Used to hint UIs the input needs to be obscured. +| Common Name | [`type`](#dataTypeType) | [`format`](#dataTypeFormat) | Comments | +| ----------- | ----------------------- | --------------------------- | ------------------------------------------------------------------------------------------------ | +| integer | `integer` | `int32` | signed 32 bits | +| long | `integer` | `int64` | signed 64 bits | +| float | `number` | `float` | | +| double | `number` | `double` | | +| string | `string` | | | +| byte | `string` | `byte` | base64 encoded characters | +| binary | `string` | `binary` | any sequence of octets | +| boolean | `boolean` | | | +| date | `string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| password | `string` | `password` | Used to hint UIs the input needs to be obscured. | ### Schema @@ -104,29 +109,29 @@ This is the root document object for the API specification. It combines what pre ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -swagger | `string` | **Required.** Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be `"2.0"`. -info | [Info Object](#info-object) | **Required.** Provides metadata about the API. The metadata can be used by the clients if needed. -host | `string` | The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the `host` is not included, the host serving the documentation is to be used (including the port). The `host` does not support [path templating](#path-templating). -basePath | `string` | The base path on which the API is served, which is relative to the [`host`](#swaggerHost). If it is not included, the API is served directly under the `host`. The value MUST start with a leading slash (`/`). The `basePath` does not support [path templating](#path-templating). -schemes | [`string`] | The transfer protocol of the API. Values MUST be from the list: `"http"`, `"https"`, `"ws"`, `"wss"`. If the `schemes` is not included, the default scheme to be used is the one used to access the Swagger definition itself. -consumes | [`string`] | A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under [Mime Types](#mime-types). -produces | [`string`] | A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under [Mime Types](#mime-types). -paths | [Paths Object](#paths-object) | **Required.** The available paths and operations for the API. -definitions | [Definitions Object](#definitions-object) | An object to hold data types produced and consumed by operations. -parameters | [Parameters Definitions Object](#parameters-definitions-object) | An object to hold parameters that can be used across operations. This property *does not* define global parameters for all operations. -responses | [Responses Definitions Object](#responses-definitions-object) | An object to hold responses that can be used across operations. This property *does not* define global responses for all operations. -securityDefinitions | [Security Definitions Object](#security-definitions-object) | Security scheme definitions that can be used across the specification. -security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition. -tags | [[Tag Object](#tag-object)] | 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](#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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. +| Field Name | Type | Description | +| ------------------------------------------------------------ | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| swagger | `string` | **Required.** Specifies the Swagger Specification version being used. It can be used by the Swagger UI and other clients to interpret the API listing. The value MUST be `"2.0"`. | +| info | [Info Object](#info-object) | **Required.** Provides metadata about the API. The metadata can be used by the clients if needed. | +| host | `string` | The host (name or ip) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the `host` is not included, the host serving the documentation is to be used (including the port). The `host` does not support [path templating](#path-templating). | +| basePath | `string` | The base path on which the API is served, which is relative to the [`host`](#swaggerHost). If it is not included, the API is served directly under the `host`. The value MUST start with a leading slash (`/`). The `basePath` does not support [path templating](#path-templating). | +| schemes | [`string`] | The transfer protocol of the API. Values MUST be from the list: `"http"`, `"https"`, `"ws"`, `"wss"`. If the `schemes` is not included, the default scheme to be used is the one used to access the Swagger definition itself. | +| consumes | [`string`] | A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under [Mime Types](#mime-types). | +| produces | [`string`] | A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under [Mime Types](#mime-types). | +| paths | [Paths Object](#paths-object) | **Required.** The available paths and operations for the API. | +| definitions | [Definitions Object](#definitions-object) | An object to hold data types produced and consumed by operations. | +| parameters | [Parameters Definitions Object](#parameters-definitions-object) | An object to hold parameters that can be used across operations. This property _does not_ define global parameters for all operations. | +| responses | [Responses Definitions Object](#responses-definitions-object) | An object to hold responses that can be used across operations. This property _does not_ define global responses for all operations. | +| securityDefinitions | [Security Definitions Object](#security-definitions-object) | Security scheme definitions that can be used across the specification. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security schemes are applied for the API as a whole. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). Individual operations can override this definition. | +| tags | [[Tag Object](#tag-object)] | 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ----------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | #### Info Object @@ -134,20 +139,20 @@ The object provides metadata about the API. The metadata can be used by the clie ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -title | `string` | **Required.** The title of the application. -description | `string` | A short description of the application. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. -termsOfService | `string` | The Terms of Service for the API. -contact | [Contact Object](#contact-object) | The contact information for the exposed API. -license | [License Object](#license-object) | The license information for the exposed API. -version | `string` | **Required** Provides the version of the application API (not to be confused with the specification version). +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **Required.** The title of the application. | +| description | `string` | A short description of the application. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. | +| termsOfService | `string` | The Terms of Service for the API. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **Required** Provides the version of the application API (not to be confused with the specification version). | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| -------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Info Object Example: @@ -189,17 +194,17 @@ Contact information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | The identifying name of the contact person/organization. -url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. -email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. +| Field Name | Type | Description | +| -------------------------------- | :------: | ------------------------------------------------------------------------------------------------ | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | +| email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ----------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Contact Object Example: @@ -223,16 +228,16 @@ License information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **Required.** The license name used for the API. -url | `string` | A URL to the license used for the API. MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------ | :------: | ---------------------------------------------------------------------- | +| name | `string` | **Required.** The license name used for the API. | +| url | `string` | A URL to the license used for the API. MUST be in the format of a URL. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ----------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### License Object Example: @@ -255,10 +260,10 @@ The Paths may be empty, due to [ACL constraints](#security-filtering). ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -/{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the [`basePath`](#swaggerBasePath) in order to construct the full URL. [Path templating](#path-templating) is allowed. -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| --------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the [`basePath`](#swaggerBasePath) in order to construct the full URL. [Path templating](#path-templating) is allowed. | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Paths Object Example @@ -291,14 +296,14 @@ Field Pattern | Type | Description get: description: Returns all pets from the system that the user has access to produces: - - application/json + - application/json responses: - '200': + "200": description: A list of pets. schema: type: array items: - $ref: '#/definitions/pet' + $ref: "#/definitions/pet" ``` #### Path Item Object @@ -308,23 +313,23 @@ A Path Item may be empty, due to [ACL constraints](#security-filtering). The pat ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is *undefined*. -get | [Operation Object](#operation-object) | A definition of a GET operation on this path. -put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. -post | [Operation Object](#operation-object) | A definition of a POST operation on this path. -delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. -options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. -head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. -patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [Swagger Object's parameters](#swaggerParameters). There can be one "body" parameter at most. +| Field Name | Type | Description | +| ------------------------------------------- | :------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is _undefined_. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [Swagger Object's parameters](#swaggerParameters). There can be one "body" parameter at most. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ------------------------------------ | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Path Item Object Example @@ -378,28 +383,28 @@ get: summary: Find pets by ID operationId: getPetsById produces: - - application/json - - text/html + - application/json + - text/html responses: - '200': + "200": description: pet response schema: type: array items: - $ref: '#/definitions/Pet' + $ref: "#/definitions/Pet" default: description: error payload schema: - $ref: '#/definitions/ErrorModel' + $ref: "#/definitions/ErrorModel" parameters: -- name: id - in: path - description: ID of pet to use - required: true - type: array - items: - type: string - collectionFormat: csv + - name: id + in: path + description: ID of pet to use + required: true + type: array + items: + type: string + collectionFormat: csv ``` #### Operation Object @@ -408,26 +413,26 @@ Describes a single API operation on a path. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. -summary | `string` | A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters. -description | `string` | A verbose explanation of the operation behavior. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. -operationId | `string` | 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. -consumes | [`string`] | A list of MIME types the operation can consume. This overrides the [`consumes`](#swaggerConsumes) definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](#mime-types). -produces | [`string`] | A list of MIME types the operation can produce. This overrides the [`produces`](#swaggerProduces) definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](#mime-types). -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [Swagger Object's parameters](#swaggerParameters). There can be one "body" parameter at most. -responses | [Responses Object](#responses-object) | **Required.** The list of possible responses as they are returned from executing this operation. -schemes | [`string`] | The transfer protocol for the operation. Values MUST be from the list: `"http"`, `"https"`, `"ws"`, `"wss"`. The value overrides the Swagger Object [`schemes`](#swaggerSchemes) definition. -deprecated | `boolean` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is `false`. -security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level [`security`](#swaggerSecurity). To remove a top-level security declaration, an empty array can be used. +| Field Name | Type | Description | +| ------------------------------------------------ | :------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters. | +| description | `string` | A verbose explanation of the operation behavior. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | 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. | +| consumes | [`string`] | A list of MIME types the operation can consume. This overrides the [`consumes`](#swaggerConsumes) definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](#mime-types). | +| produces | [`string`] | A list of MIME types the operation can produce. This overrides the [`produces`](#swaggerProduces) definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](#mime-types). | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [Swagger Object's parameters](#swaggerParameters). There can be one "body" parameter at most. | +| responses | [Responses Object](#responses-object) | **Required.** The list of possible responses as they are returned from executing this operation. | +| schemes | [`string`] | The transfer protocol for the operation. Values MUST be from the list: `"http"`, `"https"`, `"ws"`, `"wss"`. The value overrides the Swagger Object [`schemes`](#swaggerSchemes) definition. | +| deprecated | `boolean` | Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security schemes are applied for this operation. The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements). This definition overrides any declared top-level [`security`](#swaggerSecurity). To remove a top-level security declaration, an empty array can be used. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ------------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Operation Object Example @@ -490,59 +495,58 @@ Field Pattern | Type | Description ```yaml tags: -- pet + - pet summary: Updates a pet in the store with form data description: "" operationId: updatePetWithForm consumes: -- application/x-www-form-urlencoded + - application/x-www-form-urlencoded produces: -- application/json -- application/xml + - application/json + - application/xml parameters: -- name: petId - in: path - description: ID of pet that needs to be updated - required: true - type: string -- name: name - in: formData - description: Updated name of the pet - required: false - type: string -- name: status - in: formData - description: Updated status of the pet - required: false - type: string + - name: petId + in: path + description: ID of pet that needs to be updated + required: true + type: string + - name: name + in: formData + description: Updated name of the pet + required: false + type: string + - name: status + in: formData + description: Updated status of the pet + required: false + type: string responses: - '200': + "200": description: Pet updated. - '405': + "405": description: Invalid input security: -- petstore_auth: - - write:pets - - read:pets + - petstore_auth: + - write:pets + - read:pets ``` - #### External Documentation Object Allows referencing an external resource for extended documentation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A short description of the target documentation. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. -url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A short description of the target documentation. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. | +| url | `string` | **Required.** The URL for the target documentation. Value MUST be in the format of a URL. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| --------------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### External Documentation Object Example @@ -565,63 +569,65 @@ Describes a single operation parameter. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). There are five possible parameter types. -* Path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* Query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. -* Header - Custom headers that are expected as part of the request. -* Body - The payload that's appended to the HTTP request. Since there can only be one payload, there can only be *one* body parameter. The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only. Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation. -* Form - Used to describe the payload of an HTTP request when either `application/x-www-form-urlencoded`, `multipart/form-data` or both are used as the content type of the request (in Swagger's definition, the [`consumes`](#operationConsumes) property of an operation). This is the only parameter type that can be used to send files, thus supporting the `file` type. Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. Form parameters have a different format based on the content-type used (for further details, consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4): - * `application/x-www-form-urlencoded` - Similar to the format of Query parameters but as a payload. For example, `foo=1&bar=swagger` - both `foo` and `bar` are form parameters. This is normally used for simple parameters that are being transferred. - * `multipart/form-data` - each parameter takes a section in the payload with an internal header. For example, for the header `Content-Disposition: form-data; name="submit-name"` the name of the parameter is `submit-name`. This type of form parameters is more commonly used for file transfers. + +- Path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- Query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +- Header - Custom headers that are expected as part of the request. +- Body - The payload that's appended to the HTTP request. Since there can only be one payload, there can only be _one_ body parameter. The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only. Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation. +- Form - Used to describe the payload of an HTTP request when either `application/x-www-form-urlencoded`, `multipart/form-data` or both are used as the content type of the request (in Swagger's definition, the [`consumes`](#operationConsumes) property of an operation). This is the only parameter type that can be used to send files, thus supporting the `file` type. Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. Form parameters have a different format based on the content-type used (for further details, consult http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4): + - `application/x-www-form-urlencoded` - Similar to the format of Query parameters but as a payload. For example, `foo=1&bar=swagger` - both `foo` and `bar` are form parameters. This is normally used for simple parameters that are being transferred. + - `multipart/form-data` - each parameter takes a section in the payload with an internal header. For example, for the header `Content-Disposition: form-data; name="submit-name"` the name of the parameter is `submit-name`. This type of form parameters is more commonly used for file transfers. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **Required.** The name of the parameter. Parameter names are *case sensitive*. -in | `string` | **Required.** The location of the parameter. Possible values are "query", "header", "path", "formData" or "body". -description | `string` | A brief description of the parameter. This could contain examples of use. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. -required | `boolean` | Determines whether this parameter is mandatory. If the parameter is [`in`](#parameterIn) "path", this property is **required** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. + +| Field Name | Type | Description | +| ---------------------------------------------- | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **Required.** The name of the parameter. Parameter names are _case sensitive_. | +| in | `string` | **Required.** The location of the parameter. Possible values are "query", "header", "path", "formData" or "body". | +| description | `string` | A brief description of the parameter. This could contain examples of use. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the parameter is [`in`](#parameterIn) "path", this property is **required** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | If [`in`](#parameterIn) is `"body"`: -Field Name | Type | Description ----|:---:|--- -schema | [Schema Object](#schema-object) | **Required.** The schema defining the type used for the body parameter. +| Field Name | Type | Description | +| ------------------------------------ | :-----------------------------: | ----------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) | **Required.** The schema defining the type used for the body parameter. | If [`in`](#parameterIn) is any value other than `"body"`: -Field Name | Type | Description ----|:---:|--- -type | `string` | **Required.** The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, `"array"` or `"file"`. If `type` is `"file"`, the [`consumes`](#operationConsumes) MUST be either `"multipart/form-data"`, `" application/x-www-form-urlencoded"` or both and the parameter MUST be [`in`](#parameterIn) `"formData"`. -format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](#dataTypeFormat) for further details. -allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for either `query` or `formData` parameters and allows you to send a parameter with a name only or an empty value. Default value is `false`. -items | [Items Object](#items-object) | **Required if [`type`](#parameterType) is "array".** Describes the type of items in the array. -collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. -default | * | Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#parameterType) for this parameter. -maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. -exclusiveMaximum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. -minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. -exclusiveMinimum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. -maxLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. -minLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. -pattern | `string` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. -maxItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. -minItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. -uniqueItems | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. -enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. -multipleOf | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. - +| Field Name | Type | Description | +| -------------------------------------------------------- | :---------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| type | `string` | **Required.** The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, `"array"` or `"file"`. If `type` is `"file"`, the [`consumes`](#operationConsumes) MUST be either `"multipart/form-data"`, `" application/x-www-form-urlencoded"` or both and the parameter MUST be [`in`](#parameterIn) `"formData"`. | +| format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](#dataTypeFormat) for further details. | +| allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for either `query` or `formData` parameters and allows you to send a parameter with a name only or an empty value. Default value is `false`. | +| items | [Items Object](#items-object) | **Required if [`type`](#parameterType) is "array".** Describes the type of items in the array. | +| collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. | +| default | \* | Declares the value of the parameter that the server will use if none is provided, for example a "count" to control the number of results per page might default to 100 if not supplied by the client in the request. (Note: "default" has no meaning for required parameters.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#parameterType) for this parameter. | +| maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | +| exclusiveMaximum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | +| minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | +| exclusiveMinimum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | +| maxLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. | +| minLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. | +| pattern | `string` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. | +| maxItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. | +| minItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. | +| uniqueItems | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. | +| enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. | +| multipleOf | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ------------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Parameter Object Examples ###### Body Parameters A body parameter with a referenced schema definition (normally for a model definition): + ```js { "name": "user", @@ -640,10 +646,11 @@ in: body description: user to add to the system required: true schema: - $ref: '#/definitions/User' + $ref: "#/definitions/User" ``` A body parameter that is an array of string values: + ```js { "name": "user", @@ -702,6 +709,7 @@ collectionFormat: csv ``` A path parameter of a string value: + ```js { "name": "username", @@ -721,6 +729,7 @@ type: string ``` An optional query parameter of a string value, allowing multiple values by repeating the query parameter: + ```js { "name": "id", @@ -747,6 +756,7 @@ collectionFormat: multi ``` A form data with file type for a file upload: + ```js { "name": "avatar", @@ -770,35 +780,36 @@ type: file A limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located [`in`](#parameterIn) `"body"`. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -type | `string` | **Required.** The internal type of the array. The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, or `"array"`. Files and models are not allowed. -format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](#dataTypeFormat) for further details. -items | [Items Object](#items-object) | **Required if [`type`](#itemsType) is "array".** Describes the type of items in the array. -collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. -default | * | Declares the value of the item that the server will use if none is provided. (Note: "default" has no meaning for required items.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#itemsType) for the data type. -maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. -exclusiveMaximum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. -minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. -exclusiveMinimum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. -maxLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. -minLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. -pattern | `string` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. -maxItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. -minItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. -uniqueItems | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. -enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. -multipleOf | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. + +| Field Name | Type | Description | +| ---------------------------------------------------- | :---------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| type | `string` | **Required.** The internal type of the array. The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, or `"array"`. Files and models are not allowed. | +| format | `string` | The extending format for the previously mentioned [`type`](#parameterType). See [Data Type Formats](#dataTypeFormat) for further details. | +| items | [Items Object](#items-object) | **Required if [`type`](#itemsType) is "array".** Describes the type of items in the array. | +| collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. | +| default | \* | Declares the value of the item that the server will use if none is provided. (Note: "default" has no meaning for required items.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#itemsType) for the data type. | +| maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | +| exclusiveMaximum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | +| minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | +| exclusiveMinimum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | +| maxLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. | +| minLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. | +| pattern | `string` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. | +| maxItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. | +| minItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. | +| uniqueItems | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. | +| enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. | +| multipleOf | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| --------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Items Object Examples -Items must be of type string and have the minimum length of 2 characters: +Items must be of type string and have the minimum length of 2 characters: ```js { @@ -842,16 +853,17 @@ The `default` can be used as the default response object for all HTTP codes that The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses. [Reference Object](#reference-object) can be used to link to a response that is defined at the [Swagger Object's responses](#swaggerResponses) section. + +| Field Name | Type | Description | +| -------------------------------------- | :--------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. It can be used to cover undeclared responses. [Reference Object](#reference-object) can be used to link to a response that is defined at the [Swagger Object's responses](#swaggerResponses) section. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{[HTTP Status Code](#http-status-codes)} | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code. [Reference Object](#reference-object) can be used to link to a response that is defined at the [Swagger Object's responses](#swaggerResponses) section. -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| -------------------------------------------------------------------- | :--------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {[HTTP Status Code](#http-status-codes)} | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name (one property per HTTP status code). Describes the expected response for that HTTP status code. [Reference Object](#reference-object) can be used to link to a response that is defined at the [Swagger Object's responses](#swaggerResponses) section. | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Responses Object Example @@ -875,32 +887,34 @@ A 200 response for successful operation and a default response for others (imply ``` ```yaml -'200': +"200": description: a pet to be returned schema: - $ref: '#/definitions/Pet' + $ref: "#/definitions/Pet" default: description: Unexpected error schema: - $ref: '#/definitions/ErrorModel' + $ref: "#/definitions/ErrorModel" ``` #### Response Object + Describes a single response from an API Operation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | **Required.** A short description of the response. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. -schema | [Schema Object](#schema-object) | A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the [Schema Object](#schema-object), its root `type` value may also be `"file"`. This SHOULD be accompanied by a relevant `produces` mime-type. -headers | [Headers Object](#headers-object) | A list of headers that are sent with the response. -examples | [Example Object](#example-object) | An example of the response message. + +| Field Name | Type | Description | +| --------------------------------------------- | :-------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | **Required.** A short description of the response. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. | +| schema | [Schema Object](#schema-object) | A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the [Schema Object](#schema-object), its root `type` value may also be `"file"`. This SHOULD be accompanied by a relevant `produces` mime-type. | +| headers | [Headers Object](#headers-object) | A list of headers that are sent with the response. | +| examples | [Example Object](#example-object) | An example of the response message. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ------------------------------------ | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Response Object Examples @@ -923,7 +937,7 @@ description: A complex object array response schema: type: array items: - $ref: '#/definitions/VeryComplexType' + $ref: "#/definitions/VeryComplexType" ``` Response with a string type: @@ -997,12 +1011,14 @@ description: object created ``` #### Headers Object + Lists the headers that can be sent as part of a response. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [Header Object](#header-object) | The name of the property corresponds to the name of the header. The value describes the type of the header. + +| Field Pattern | Type | Description | +| -------------------------------- | :-----------------------------: | ----------------------------------------------------------------------------------------------------------- | +| {name} | [Header Object](#header-object) | The name of the property corresponds to the name of the header. The value describes the type of the header. | ##### Headers Object Example @@ -1042,9 +1058,10 @@ X-Rate-Limit-Reset: Allows sharing examples for operation responses. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{[mime type](#mime-types)} | Any | The name of the property MUST be one of the Operation `produces` values (either implicit or inherited). The value SHOULD be an example of what such a response would look like. + +| Field Pattern | Type | Description | +| -------------------------------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {[mime type](#mime-types)} | Any | The name of the property MUST be one of the Operation `produces` values (either implicit or inherited). The value SHOULD be an example of what such a response would look like. | ##### Example Object Example @@ -1073,32 +1090,32 @@ application/json: #### Header Object -Field Name | Type | Description ----|:---:|--- -description | `string` | A short description of the header. -type | `string` | **Required.** The type of the object. The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, or `"array"`. -format | `string` | The extending format for the previously mentioned [`type`](#stType). See [Data Type Formats](#dataTypeFormat) for further details. -items | [Items Object](#items-object) | **Required if [`type`](#stType) is "array".** Describes the type of items in the array. -collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. -default | * | Declares the value of the header that the server will use if none is provided. (Note: "default" has no meaning for required headers.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#headerDefault) for the header. -maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. -exclusiveMaximum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. -minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. -exclusiveMinimum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. -maxLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. -minLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. -pattern | `string` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. -maxItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. -minItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. -uniqueItems | `boolean` | https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. -enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. -multipleOf | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. +| Field Name | Type | Description | +| ----------------------------------------------------- | :---------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A short description of the header. | +| type | `string` | **Required.** The type of the object. The value MUST be one of `"string"`, `"number"`, `"integer"`, `"boolean"`, or `"array"`. | +| format | `string` | The extending format for the previously mentioned [`type`](#stType). See [Data Type Formats](#dataTypeFormat) for further details. | +| items | [Items Object](#items-object) | **Required if [`type`](#stType) is "array".** Describes the type of items in the array. | +| collectionFormat | `string` | Determines the format of the array if type array is used. Possible values are: Default value is `csv`. | +| default | \* | Declares the value of the header that the server will use if none is provided. (Note: "default" has no meaning for required headers.) See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-6.2. Unlike JSON Schema this value MUST conform to the defined [`type`](#headerDefault) for the header. | +| maximum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | +| exclusiveMaximum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2. | +| minimum | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | +| exclusiveMinimum | `boolean` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3. | +| maxLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1. | +| minLength | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2. | +| pattern | `string` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3. | +| maxItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2. | +| minItems | `integer` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3. | +| uniqueItems | `boolean` | https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4. | +| enum | [*] | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1. | +| multipleOf | `number` | See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ---------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Header Object Example @@ -1121,16 +1138,18 @@ type: integer Allows adding meta data to a single tag that is used by the [Operation Object](#operation-object). It is not mandatory to have a Tag Object per tag used there. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **Required.** The name of the tag. -description | `string` | A short description for the tag. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. + +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **Required.** The name of the tag. | +| description | `string` | A short description for the tag. [GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) can be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. + +| Field Pattern | Type | Description | +| ------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Tag Object Example @@ -1153,9 +1172,10 @@ A simple object to allow referencing other definitions in the specification. It The Reference Object is a [JSON Reference](http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02) that uses a [JSON Pointer](http://tools.ietf.org/html/rfc6901) as its value. For this specification, only [canonical dereferencing](https://tools.ietf.org/html/draft-zyp-json-schema-04#section-7.2.3) is supported. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | **Required.** The reference string. + +| Field Name | Type | Description | +| ------------------------------- | :------: | ----------------------------------- | +| $ref | `string` | **Required.** The reference string. | ##### Reference Object Example @@ -1166,10 +1186,11 @@ Field Name | Type | Description ``` ```yaml -$ref: '#/definitions/Pet' +$ref: "#/definitions/Pet" ``` ##### Relative Schema File Example + ```js { "$ref": "Pet.json" @@ -1177,10 +1198,11 @@ $ref: '#/definitions/Pet' ``` ```yaml -$ref: 'Pet.yaml' +$ref: "Pet.yaml" ``` ##### Relative Files With Embedded Schema Example + ```js { "$ref": "definitions.json#/Pet" @@ -1188,7 +1210,7 @@ $ref: 'Pet.yaml' ``` ```yaml -$ref: 'definitions.yaml#/Pet' +$ref: "definitions.yaml#/Pet" ``` #### Schema Object @@ -1198,6 +1220,7 @@ The Schema Object allows the definition of input and output data types. These ty Further information about the properties can be found in [JSON Schema Core](https://tools.ietf.org/html/draft-zyp-json-schema-04) and [JSON Schema Validation](https://tools.ietf.org/html/draft-fge-json-schema-validation-00). Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here. The following properties are taken directly from the JSON Schema definition and follow the same specifications: + - $ref - As a [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03) - format (See [Data Type Formats](#dataTypeFormat) for further details) - title @@ -1221,6 +1244,7 @@ The following properties are taken directly from the JSON Schema definition and - type The following properties are taken from the JSON Schema definition but their definitions were adjusted to the Swagger Specification. Their definition is the same as the one from JSON Schema, only where the original definition references the JSON Schema definition, the [Schema Object](#schema-object) definition is used instead. + - items - allOf - properties @@ -1229,25 +1253,26 @@ The following properties are taken from the JSON Schema definition but their def Other than the JSON Schema subset fields, the following fields may be used for further schema documentation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -discriminator | `string` | Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the `required` property list. When used, the value MUST be the name of this schema or any schema that inherits it. -readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as `readOnly` being `true` SHOULD NOT be in the `required` list of the defined schema. Default value is `false`. -xml | [XML Object](#xml-object) | This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. -example | Any | A free-form property to include an example of an instance for this schema. + +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| discriminator | `string` | Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the `required` property list. When used, the value MUST be the name of this schema or any schema that inherits it. | +| readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as `readOnly` being `true` SHOULD NOT be in the `required` list of the defined schema. Default value is `false`. | +| xml | [XML Object](#xml-object) | This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form property to include an example of an instance for this schema. | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ---------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ###### Composition and Inheritance (Polymorphism) -Swagger allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition. `allOf` takes in an array of object definitions that are validated *independently* but together compose a single object. +Swagger allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition. `allOf` takes in an array of object definitions that are validated _independently_ but together compose a single object. -While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, Swagger adds the support of the `discriminator` field. When used, the `discriminator` will be the name of the property used to decide which schema definition is used to validate the structure of the model. As such, the `discriminator` field MUST be a required field. The value of the chosen property has to be the friendly name given to the model under the `definitions` property. As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism. +While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, Swagger adds the support of the `discriminator` field. When used, the `discriminator` will be the name of the property used to decide which schema definition is used to validate the structure of the model. As such, the `discriminator` field MUST be a required field. The value of the chosen property has to be the friendly name given to the model under the `definitions` property. As such, inline schema definitions, which do not have a given id, _cannot_ be used in polymorphism. ###### XML Modeling @@ -1298,12 +1323,12 @@ format: email ```yaml type: object required: -- name + - name properties: name: type: string address: - $ref: '#/definitions/Address' + $ref: "#/definitions/Address" age: type: integer format: int32 @@ -1343,7 +1368,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/definitions/ComplexModel' + $ref: "#/definitions/ComplexModel" ``` ###### Model with Example @@ -1379,7 +1404,7 @@ properties: name: type: string required: -- name + - name example: name: Puma id: 1 @@ -1434,8 +1459,8 @@ definitions: ErrorModel: type: object required: - - message - - code + - message + - code properties: message: type: string @@ -1445,13 +1470,13 @@ definitions: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/definitions/ErrorModel' - - type: object - required: - - rootCause - properties: - rootCause: - type: string + - $ref: "#/definitions/ErrorModel" + - type: object + required: + - rootCause + properties: + rootCause: + type: string ``` ###### Models with Polymorphism Support @@ -1540,61 +1565,62 @@ definitions: petType: type: string required: - - name - - petType + - name + - petType Cat: description: A representation of a cat allOf: - - $ref: '#/definitions/Pet' - - type: object - properties: - huntingSkill: - type: string - description: The measured skill for hunting - default: lazy - enum: - - clueless - - lazy - - adventurous - - aggressive - required: - - huntingSkill + - $ref: "#/definitions/Pet" + - type: object + properties: + huntingSkill: + type: string + description: The measured skill for hunting + default: lazy + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill Dog: description: A representation of a dog allOf: - - $ref: '#/definitions/Pet' - - type: object - properties: - packSize: - type: integer - format: int32 - description: the size of the pack the dog is from - default: 0 - minimum: 0 - required: - - packSize + - $ref: "#/definitions/Pet" + - type: object + properties: + packSize: + type: integer + format: int32 + description: the size of the pack the dog is from + default: 0 + minimum: 0 + required: + - packSize ``` #### XML Object A metadata object that allows for more fine-tuned XML model definitions. -When using arrays, XML element names are *not* inferred (for singular/plural forms) and the `name` property should be used to add that information. See examples for expected behavior. +When using arrays, XML element names are _not_ inferred (for singular/plural forms) and the `name` property should be used to add that information. See examples for expected behavior. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (`items`), it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. -namespace | `string` | The URL of the namespace definition. Value SHOULD be in the form of a URL. -prefix | `string` | The prefix to be used for the [name](#xmlName). -attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. -wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). + +| Field Name | Type | Description | +| ------------------------------------ | :-------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (`items`), it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | The URL of the namespace definition. Value SHOULD be in the form of a URL. | +| prefix | `string` | The prefix to be used for the [name](#xmlName). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### XML Object Examples @@ -1671,7 +1697,6 @@ animals: ... ``` - ###### XML Attribute, Prefix and Namespace In this example, a full model definition is shown. @@ -1937,9 +1962,9 @@ An object to hold data types that can be consumed and produced by operations. Th ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [Schema Object](#schema-object) | A single definition, mapping a "name" to the schema it defines. +| Field Pattern | Type | Description | +| ------------------------------------ | :-----------------------------: | --------------------------------------------------------------- | +| {name} | [Schema Object](#schema-object) | A single definition, mapping a "name" to the schema it defines. | ##### Definitions Object Example @@ -1995,13 +2020,13 @@ Tag: An object to hold parameters to be reused across operations. Parameter definitions can be referenced to the ones defined here. -This does *not* define global operation parameters. +This does _not_ define global operation parameters. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [Parameter Object](#parameter-object) | A single parameter definition, mapping a "name" to the parameter it defines. +| Field Pattern | Type | Description | +| --------------------------- | :-----------------------------------: | ---------------------------------------------------------------------------- | +| {name} | [Parameter Object](#parameter-object) | A single parameter definition, mapping a "name" to the parameter it defines. | ##### Parameters Definition Object Example @@ -2043,18 +2068,17 @@ limitParam: format: int32 ``` - #### Responses Definitions Object An object to hold responses to be reused across operations. Response definitions can be referenced to the ones defined here. -This does *not* define global operation responses. +This does _not_ define global operation responses. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [Response Object](#response-object) | A single response definition, mapping a "name" to the response it defines. +| Field Pattern | Type | Description | +| --------------------------- | :---------------------------------: | -------------------------------------------------------------------------- | +| {name} | [Response Object](#response-object) | A single response definition, mapping a "name" to the response it defines. | ##### Responses Definitions Object Example @@ -2083,7 +2107,7 @@ IllegalInput: GeneralError: description: General Error schema: - $ref: '#/definitions/GeneralError' + $ref: "#/definitions/GeneralError" ``` #### Security Definitions Object @@ -2091,9 +2115,10 @@ GeneralError: A declaration of the security schemes available to be used in the specification. This does not enforce the security schemes on the operations and only serves to provide the relevant details for each scheme. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [Security Scheme Object](#security-scheme-object) | A single security scheme definition, mapping a "name" to the scheme it defines. + +| Field Pattern | Type | Description | +| --------------------------- | :-----------------------------------------------: | ------------------------------------------------------------------------------- | +| {name} | [Security Scheme Object](#security-scheme-object) | A single security scheme definition, mapping a "name" to the scheme it defines. | ##### Security Definitions Object Example @@ -2135,22 +2160,23 @@ petstore_auth: Allows the definition of a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code). ##### Fixed Fields -Field Name | Type | Validity | Description ----|:---:|---|--- -type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"basic"`, `"apiKey"` or `"oauth2"`. -description | `string` | Any | A short description for security scheme. -name | `string` | `apiKey` | **Required.** The name of the header or query parameter to be used. -in | `string` | `apiKey` | **Required** The location of the API key. Valid values are `"query"` or `"header"`. -flow | `string` | `oauth2` | **Required.** The flow used by the OAuth2 security scheme. Valid values are `"implicit"`, `"password"`, `"application"` or `"accessCode"`. -authorizationUrl | `string` | `oauth2` (`"implicit"`, `"accessCode"`) | **Required.** The authorization URL to be used for this flow. This SHOULD be in the form of a URL. -tokenUrl | `string` | `oauth2` (`"password"`, `"application"`, `"accessCode"`) | **Required.** The token URL to be used for this flow. This SHOULD be in the form of a URL. -scopes | [Scopes Object](#scopes-object) | `oauth2` | **Required.** The available scopes for the OAuth2 security scheme. + +| Field Name | Type | Validity | Description | +| ------------------------------------------------------------- | :-----------------------------: | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"basic"`, `"apiKey"` or `"oauth2"`. | +| description | `string` | Any | A short description for security scheme. | +| name | `string` | `apiKey` | **Required.** The name of the header or query parameter to be used. | +| in | `string` | `apiKey` | **Required** The location of the API key. Valid values are `"query"` or `"header"`. | +| flow | `string` | `oauth2` | **Required.** The flow used by the OAuth2 security scheme. Valid values are `"implicit"`, `"password"`, `"application"` or `"accessCode"`. | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"accessCode"`) | **Required.** The authorization URL to be used for this flow. This SHOULD be in the form of a URL. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"application"`, `"accessCode"`) | **Required.** The token URL to be used for this flow. This SHOULD be in the form of a URL. | +| scopes | [Scopes Object](#scopes-object) | `oauth2` | **Required.** The available scopes for the OAuth2 security scheme. | ##### Patterned Fields -Field Name | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Name | Type | Description | +| ------------------------------------------ | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Security Scheme Object Example @@ -2211,15 +2237,15 @@ Lists the available scopes for an OAuth2 security scheme. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | `string` | Maps between a name of a scope to a short description of it (as the value of the property). +| Field Pattern | Type | Description | +| ------------------------------- | :------: | ------------------------------------------------------------------------------------------- | +| {name} | `string` | Maps between a name of a scope to a short description of it (as the value of the property). | ##### Patterned Objects -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. +| Field Pattern | Type | Description | +| ---------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the Swagger Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. See [Vendor Extensions](#specification-extensions) for further details. | ##### Scopes Object Example @@ -2243,9 +2269,9 @@ The name used for each property MUST correspond to a security scheme declared in ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [`string`] | Each name must correspond to a security scheme which is declared in the [Security Definitions](#securityDefinitions). If the security scheme is of type `"oauth2"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. +| Field Pattern | Type | Description | +| --------------------------------------------- | :--------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {name} | [`string`] | Each name must correspond to a security scheme which is declared in the [Security Definitions](#securityDefinitions). If the security scheme is of type `"oauth2"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. | ##### Security Requirement Object Examples @@ -2274,8 +2300,8 @@ api_key: [] ```yaml petstore_auth: -- write:pets -- read:pets + - write:pets + - read:pets ``` ### Specification Extensions diff --git a/2.0/data-types/array.ts b/2.0/data-types/array.ts index b08ffd2..bfcaf7f 100644 --- a/2.0/data-types/array.ts +++ b/2.0/data-types/array.ts @@ -107,64 +107,64 @@ import type { XMLObject } from "../xml"; * ``` */ export interface ArraySchema extends Extension { - /** - * The type of the schema. Must be "array" for array schemas. - * - * This property is required and must be set to "array" to indicate - * that this schema represents an ordered collection of items. - * - * @example "array" - */ - type: "array"; + /** + * The type of the schema. Must be "array" for array schemas. + * + * This property is required and must be set to "array" to indicate + * that this schema represents an ordered collection of items. + * + * @example "array" + */ + type: "array"; - /** - * Required if type is "array". Describes the type of items in the array. - * - * The definition is the same as the one from JSON Schema, but references - * the Swagger Schema Object definition instead. This allows for complex - * nested structures and references to other schema definitions. - * - * @example { type: "string" } - * @example { $ref: "#/definitions/User" } - * @example { type: "object", properties: { name: { type: "string" } } } - */ - items: Schema; // Forward declaration to avoid circular imports + /** + * Required if type is "array". Describes the type of items in the array. + * + * The definition is the same as the one from JSON Schema, but references + * the Swagger Schema Object definition instead. This allows for complex + * nested structures and references to other schema definitions. + * + * @example { type: "string" } + * @example { $ref: "#/definitions/User" } + * @example { type: "object", properties: { name: { type: "string" } } } + */ + items: Schema; // Forward declaration to avoid circular imports - /** - * An array is valid against "maxItems" if its length is less than or equal to this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2 | JSON Schema Validation - maxItems} - * - * @example 10 - * @example 100 - */ - maxItems?: number; + /** + * An array is valid against "maxItems" if its length is less than or equal to this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2 | JSON Schema Validation - maxItems} + * + * @example 10 + * @example 100 + */ + maxItems?: number; - /** - * An array is valid against "minItems" if its length is greater than or equal to this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3 | JSON Schema Validation - minItems} - * - * @example 1 - * @example 2 - */ - minItems?: number; + /** + * An array is valid against "minItems" if its length is greater than or equal to this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3 | JSON Schema Validation - minItems} + * + * @example 1 + * @example 2 + */ + minItems?: number; - /** - * An array is valid against "uniqueItems" if all its elements are unique. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4 | JSON Schema Validation - uniqueItems} - * - * @example true - * @example false - */ - uniqueItems?: boolean; + /** + * An array is valid against "uniqueItems" if all its elements are unique. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4 | JSON Schema Validation - uniqueItems} + * + * @example true + * @example false + */ + uniqueItems?: boolean; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * @example { name: "users", wrapped: true } - */ - xml?: XMLObject; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * @example { name: "users", wrapped: true } + */ + xml?: XMLObject; } diff --git a/2.0/data-types/boolean.ts b/2.0/data-types/boolean.ts index 2b4864b..cd39b50 100644 --- a/2.0/data-types/boolean.ts +++ b/2.0/data-types/boolean.ts @@ -81,101 +81,101 @@ import type { XMLObject } from "../xml"; * ``` */ export interface BooleanSchema extends Extension { - /** - * The type of the schema. Must be "boolean" for boolean schemas. - * - * This property is required and must be set to "boolean" to indicate - * that this schema represents true/false values. - * - * @example "boolean" - */ - type: "boolean"; + /** + * The type of the schema. Must be "boolean" for boolean schemas. + * + * This property is required and must be set to "boolean" to indicate + * that this schema represents true/false values. + * + * @example "boolean" + */ + type: "boolean"; - /** - * The extending format for the previously mentioned type. - * See Swagger 2.0 Data Type Formats for further details. - * - * Formats provide additional semantic information about the data type, - * enabling more precise validation and better tooling support. Swagger 2.0 - * defines several standard formats, but custom formats are also allowed. - * - * @see {@link https://swagger.io/specification/v2/#dataTypeFormat | Swagger 2.0 Data Type Formats} - * - * @example "int32" - * @example "date" - * @example "email" - * @example "uuid" - */ - format?: string; + /** + * The extending format for the previously mentioned type. + * See Swagger 2.0 Data Type Formats for further details. + * + * Formats provide additional semantic information about the data type, + * enabling more precise validation and better tooling support. Swagger 2.0 + * defines several standard formats, but custom formats are also allowed. + * + * @see {@link https://swagger.io/specification/v2/#dataTypeFormat | Swagger 2.0 Data Type Formats} + * + * @example "int32" + * @example "date" + * @example "email" + * @example "uuid" + */ + format?: string; - /** - * A short description of the schema. GFM syntax can be used for rich text representation. - * - * This description should provide clear information about what the schema - * represents and how it should be used. It's commonly displayed in API - * documentation and code generation tools. - * - * @example "A user object containing basic information" - * @example "Email address in RFC 5322 format" - */ - description?: string; + /** + * A short description of the schema. GFM syntax can be used for rich text representation. + * + * This description should provide clear information about what the schema + * represents and how it should be used. It's commonly displayed in API + * documentation and code generation tools. + * + * @example "A user object containing basic information" + * @example "Email address in RFC 5322 format" + */ + description?: string; - /** - * A short title for the schema. - * - * The title provides a human-readable name for the schema, often used - * in documentation and UI displays. It should be concise but descriptive. - * - * @example "User" - * @example "Pet" - * @example "Order" - */ - title?: string; + /** + * A short title for the schema. + * + * The title provides a human-readable name for the schema, often used + * in documentation and UI displays. It should be concise but descriptive. + * + * @example "User" + * @example "Pet" + * @example "Order" + */ + title?: string; - /** - * Declares the value of the schema that the server will use if none is provided. - * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. - * - * This is a Swagger 2.0 specific requirement that differs from JSON Schema. - * The default value must be valid according to the schema's type and constraints. - * - * @example "defaultValue" - * @example 10 - * @example { name: "John", age: 30 } - * @example ["item1", "item2"] - */ - default?: unknown; + /** + * Declares the value of the schema that the server will use if none is provided. + * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. + * + * This is a Swagger 2.0 specific requirement that differs from JSON Schema. + * The default value must be valid according to the schema's type and constraints. + * + * @example "defaultValue" + * @example 10 + * @example { name: "John", age: 30 } + * @example ["item1", "item2"] + */ + default?: unknown; - /** - * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 | JSON Schema Validation - enum} - * - * @example ["option1", "option2", "option3"] - * @example ["red", "green", "blue"] - * @example [1, 2, 3, 4, 5] - */ - enum?: unknown[]; + /** + * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 | JSON Schema Validation - enum} + * + * @example ["option1", "option2", "option3"] + * @example ["red", "green", "blue"] + * @example [1, 2, 3, 4, 5] + */ + enum?: unknown[]; - /** - * A free-form property to include an example of an instance for this schema. - * - * Examples help developers understand how to use the schema and what kind - * of data is expected. They are commonly used by documentation generators - * and API testing tools. - * - * @example { name: "Puma", id: 1 } - * @example "example string value" - * @example 42 - * @example ["item1", "item2"] - */ - example?: unknown; + /** + * A free-form property to include an example of an instance for this schema. + * + * Examples help developers understand how to use the schema and what kind + * of data is expected. They are commonly used by documentation generators + * and API testing tools. + * + * @example { name: "Puma", id: 1 } + * @example "example string value" + * @example 42 + * @example ["item1", "item2"] + */ + example?: unknown; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * @example { name: "isActive", attribute: false } - */ - xml?: XMLObject; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * @example { name: "isActive", attribute: false } + */ + xml?: XMLObject; } diff --git a/2.0/data-types/file.ts b/2.0/data-types/file.ts index 5e94a50..6e10b92 100644 --- a/2.0/data-types/file.ts +++ b/2.0/data-types/file.ts @@ -79,102 +79,102 @@ import type { XMLObject } from "../xml"; * ``` */ export interface FileSchema extends Extension { - /** - * The type of the schema. Must be "file" for file schemas. - * - * This property is required and must be set to "file" to indicate - * that this schema represents file data. This is a Swagger 2.0 specific - * type that extends JSON Schema. - * - * @example "file" - */ - type: "file"; + /** + * The type of the schema. Must be "file" for file schemas. + * + * This property is required and must be set to "file" to indicate + * that this schema represents file data. This is a Swagger 2.0 specific + * type that extends JSON Schema. + * + * @example "file" + */ + type: "file"; - /** - * The extending format for the previously mentioned type. - * See Swagger 2.0 Data Type Formats for further details. - * - * Formats provide additional semantic information about the data type, - * enabling more precise validation and better tooling support. Swagger 2.0 - * defines several standard formats, but custom formats are also allowed. - * - * @see {@link https://swagger.io/specification/v2/#dataTypeFormat | Swagger 2.0 Data Type Formats} - * - * @example "int32" - * @example "date" - * @example "email" - * @example "uuid" - */ - format?: string; + /** + * The extending format for the previously mentioned type. + * See Swagger 2.0 Data Type Formats for further details. + * + * Formats provide additional semantic information about the data type, + * enabling more precise validation and better tooling support. Swagger 2.0 + * defines several standard formats, but custom formats are also allowed. + * + * @see {@link https://swagger.io/specification/v2/#dataTypeFormat | Swagger 2.0 Data Type Formats} + * + * @example "int32" + * @example "date" + * @example "email" + * @example "uuid" + */ + format?: string; - /** - * A short description of the schema. GFM syntax can be used for rich text representation. - * - * This description should provide clear information about what the schema - * represents and how it should be used. It's commonly displayed in API - * documentation and code generation tools. - * - * @example "A user object containing basic information" - * @example "Email address in RFC 5322 format" - */ - description?: string; + /** + * A short description of the schema. GFM syntax can be used for rich text representation. + * + * This description should provide clear information about what the schema + * represents and how it should be used. It's commonly displayed in API + * documentation and code generation tools. + * + * @example "A user object containing basic information" + * @example "Email address in RFC 5322 format" + */ + description?: string; - /** - * A short title for the schema. - * - * The title provides a human-readable name for the schema, often used - * in documentation and UI displays. It should be concise but descriptive. - * - * @example "User" - * @example "Pet" - * @example "Order" - */ - title?: string; + /** + * A short title for the schema. + * + * The title provides a human-readable name for the schema, often used + * in documentation and UI displays. It should be concise but descriptive. + * + * @example "User" + * @example "Pet" + * @example "Order" + */ + title?: string; - /** - * Declares the value of the schema that the server will use if none is provided. - * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. - * - * This is a Swagger 2.0 specific requirement that differs from JSON Schema. - * The default value must be valid according to the schema's type and constraints. - * - * @example "defaultValue" - * @example 10 - * @example { name: "John", age: 30 } - * @example ["item1", "item2"] - */ - default?: unknown; + /** + * Declares the value of the schema that the server will use if none is provided. + * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. + * + * This is a Swagger 2.0 specific requirement that differs from JSON Schema. + * The default value must be valid according to the schema's type and constraints. + * + * @example "defaultValue" + * @example 10 + * @example { name: "John", age: 30 } + * @example ["item1", "item2"] + */ + default?: unknown; - /** - * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 | JSON Schema Validation - enum} - * - * @example ["option1", "option2", "option3"] - * @example ["red", "green", "blue"] - * @example [1, 2, 3, 4, 5] - */ - enum?: unknown[]; + /** + * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 | JSON Schema Validation - enum} + * + * @example ["option1", "option2", "option3"] + * @example ["red", "green", "blue"] + * @example [1, 2, 3, 4, 5] + */ + enum?: unknown[]; - /** - * A free-form property to include an example of an instance for this schema. - * - * Examples help developers understand how to use the schema and what kind - * of data is expected. They are commonly used by documentation generators - * and API testing tools. - * - * @example { name: "Puma", id: 1 } - * @example "example string value" - * @example 42 - * @example ["item1", "item2"] - */ - example?: unknown; + /** + * A free-form property to include an example of an instance for this schema. + * + * Examples help developers understand how to use the schema and what kind + * of data is expected. They are commonly used by documentation generators + * and API testing tools. + * + * @example { name: "Puma", id: 1 } + * @example "example string value" + * @example 42 + * @example ["item1", "item2"] + */ + example?: unknown; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * @example { name: "fileData", attribute: false } - */ - xml?: XMLObject; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * @example { name: "fileData", attribute: false } + */ + xml?: XMLObject; } diff --git a/2.0/data-types/integer.ts b/2.0/data-types/integer.ts index 3cf369c..99251c1 100644 --- a/2.0/data-types/integer.ts +++ b/2.0/data-types/integer.ts @@ -94,150 +94,150 @@ import type { XMLObject } from "../xml"; * ``` */ export interface IntegerSchema extends Extension { - /** - * The type of the schema. Must be "integer" for integer schemas. - * - * This property is required and must be set to "integer" to indicate - * that this schema represents whole number data without fractional components. - * - * @example "integer" - */ - type: "integer"; + /** + * The type of the schema. Must be "integer" for integer schemas. + * + * This property is required and must be set to "integer" to indicate + * that this schema represents whole number data without fractional components. + * + * @example "integer" + */ + type: "integer"; - /** - * The extending format for the previously mentioned type. - * See Swagger 2.0 Data Type Formats for further details. - * - * Formats provide additional semantic information about the data type, - * enabling more precise validation and better tooling support. Swagger 2.0 - * defines several standard formats, but custom formats are also allowed. - * - * @see {@link https://swagger.io/specification/v2/#dataTypeFormat | Swagger 2.0 Data Type Formats} - * - * @example "int32" - * @example "int64" - */ - format?: string; + /** + * The extending format for the previously mentioned type. + * See Swagger 2.0 Data Type Formats for further details. + * + * Formats provide additional semantic information about the data type, + * enabling more precise validation and better tooling support. Swagger 2.0 + * defines several standard formats, but custom formats are also allowed. + * + * @see {@link https://swagger.io/specification/v2/#dataTypeFormat | Swagger 2.0 Data Type Formats} + * + * @example "int32" + * @example "int64" + */ + format?: string; - /** - * A short description of the schema. GFM syntax can be used for rich text representation. - * - * This description should provide clear information about what the schema - * represents and how it should be used. It's commonly displayed in API - * documentation and code generation tools. - * - * @example "A user object containing basic information" - * @example "Email address in RFC 5322 format" - */ - description?: string; + /** + * A short description of the schema. GFM syntax can be used for rich text representation. + * + * This description should provide clear information about what the schema + * represents and how it should be used. It's commonly displayed in API + * documentation and code generation tools. + * + * @example "A user object containing basic information" + * @example "Email address in RFC 5322 format" + */ + description?: string; - /** - * A short title for the schema. - * - * The title provides a human-readable name for the schema, often used - * in documentation and UI displays. It should be concise but descriptive. - * - * @example "User" - * @example "Pet" - * @example "Order" - */ - title?: string; + /** + * A short title for the schema. + * + * The title provides a human-readable name for the schema, often used + * in documentation and UI displays. It should be concise but descriptive. + * + * @example "User" + * @example "Pet" + * @example "Order" + */ + title?: string; - /** - * Declares the value of the schema that the server will use if none is provided. - * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. - * - * This is a Swagger 2.0 specific requirement that differs from JSON Schema. - * The default value must be valid according to the schema's type and constraints. - * - * @example "defaultValue" - * @example 10 - * @example { name: "John", age: 30 } - * @example ["item1", "item2"] - */ - default?: unknown; + /** + * Declares the value of the schema that the server will use if none is provided. + * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. + * + * This is a Swagger 2.0 specific requirement that differs from JSON Schema. + * The default value must be valid according to the schema's type and constraints. + * + * @example "defaultValue" + * @example 10 + * @example { name: "John", age: 30 } + * @example ["item1", "item2"] + */ + default?: unknown; - /** - * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 | JSON Schema Validation - enum} - * - * @example ["option1", "option2", "option3"] - * @example ["red", "green", "blue"] - * @example [1, 2, 3, 4, 5] - */ - enum?: unknown[]; + /** + * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 | JSON Schema Validation - enum} + * + * @example ["option1", "option2", "option3"] + * @example ["red", "green", "blue"] + * @example [1, 2, 3, 4, 5] + */ + enum?: unknown[]; - /** - * A free-form property to include an example of an instance for this schema. - * - * Examples help developers understand how to use the schema and what kind - * of data is expected. They are commonly used by documentation generators - * and API testing tools. - * - * @example { name: "Puma", id: 1 } - * @example "example string value" - * @example 42 - * @example ["item1", "item2"] - */ - example?: unknown; + /** + * A free-form property to include an example of an instance for this schema. + * + * Examples help developers understand how to use the schema and what kind + * of data is expected. They are commonly used by documentation generators + * and API testing tools. + * + * @example { name: "Puma", id: 1 } + * @example "example string value" + * @example 42 + * @example ["item1", "item2"] + */ + example?: unknown; - /** - * A number is valid against "multipleOf" if the result of the division - * of the instance by this keyword's value is an integer. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1 | JSON Schema Validation - multipleOf} - * - * @example 2 - * @example 1 - */ - multipleOf?: number; + /** + * A number is valid against "multipleOf" if the result of the division + * of the instance by this keyword's value is an integer. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1 | JSON Schema Validation - multipleOf} + * + * @example 2 + * @example 1 + */ + multipleOf?: number; - /** - * A number is valid against "maximum" if it is less than or equal to this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 | JSON Schema Validation - maximum} - * - * @example 100 - * @example 2147483647 - */ - maximum?: number; + /** + * A number is valid against "maximum" if it is less than or equal to this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 | JSON Schema Validation - maximum} + * + * @example 100 + * @example 2147483647 + */ + maximum?: number; - /** - * A number is valid against "exclusiveMaximum" if it is strictly less than this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 | JSON Schema Validation - exclusiveMaximum} - * - * @example false - * @example true - */ - exclusiveMaximum?: boolean; + /** + * A number is valid against "exclusiveMaximum" if it is strictly less than this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 | JSON Schema Validation - exclusiveMaximum} + * + * @example false + * @example true + */ + exclusiveMaximum?: boolean; - /** - * A number is valid against "minimum" if it is greater than or equal to this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 | JSON Schema Validation - minimum} - * - * @example 0 - * @example 1 - */ - minimum?: number; + /** + * A number is valid against "minimum" if it is greater than or equal to this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 | JSON Schema Validation - minimum} + * + * @example 0 + * @example 1 + */ + minimum?: number; - /** - * A number is valid against "exclusiveMinimum" if it is strictly greater than this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 | JSON Schema Validation - exclusiveMinimum} - * - * @example false - * @example true - */ - exclusiveMinimum?: boolean; + /** + * A number is valid against "exclusiveMinimum" if it is strictly greater than this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 | JSON Schema Validation - exclusiveMinimum} + * + * @example false + * @example true + */ + exclusiveMinimum?: boolean; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * @example { name: "userId", attribute: false } - */ - xml?: XMLObject; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * @example { name: "userId", attribute: false } + */ + xml?: XMLObject; } diff --git a/2.0/data-types/object.ts b/2.0/data-types/object.ts index f5d0c6b..b17fb33 100644 --- a/2.0/data-types/object.ts +++ b/2.0/data-types/object.ts @@ -118,98 +118,98 @@ import type { XMLObject } from "../xml"; * ``` */ export interface ObjectSchema extends Extension { - /** - * The type of the schema. Must be "object" for object schemas. - * - * This property is required and must be set to "object" to indicate - * that this schema represents structured data with named properties. - * - * @example "object" - */ - type?: "object"; + /** + * The type of the schema. Must be "object" for object schemas. + * + * This property is required and must be set to "object" to indicate + * that this schema represents structured data with named properties. + * + * @example "object" + */ + type?: "object"; - /** - * The properties of the object. The definition is the same as the one from - * JSON Schema, but references the Swagger Schema Object definition instead. - * - * Each property name maps to a schema definition that describes the type - * and validation rules for that property. Properties can be of any type - * supported by Swagger schemas, including primitives, objects, arrays, - * and references. - * - * @example { name: { type: "string" }, age: { type: "integer" } } - * @example { address: { $ref: "#/definitions/Address" } } - */ - properties?: Record; // Forward declaration to avoid circular imports + /** + * The properties of the object. The definition is the same as the one from + * JSON Schema, but references the Swagger Schema Object definition instead. + * + * Each property name maps to a schema definition that describes the type + * and validation rules for that property. Properties can be of any type + * supported by Swagger schemas, including primitives, objects, arrays, + * and references. + * + * @example { name: { type: "string" }, age: { type: "integer" } } + * @example { address: { $ref: "#/definitions/Address" } } + */ + properties?: Record; // Forward declaration to avoid circular imports - /** - * A list of required properties. Properties marked as required being true - * MUST be present in the object. - * - * This array contains the names of properties that must be present in - * any valid instance of this object schema. Properties not listed here - * are considered optional. - * - * @example ["name", "email"] - * @example ["id", "type", "createdAt"] - */ - required?: string[]; + /** + * A list of required properties. Properties marked as required being true + * MUST be present in the object. + * + * This array contains the names of properties that must be present in + * any valid instance of this object schema. Properties not listed here + * are considered optional. + * + * @example ["name", "email"] + * @example ["id", "type", "createdAt"] + */ + required?: string[]; - /** - * Additional properties for the object. Can be a boolean or a schema. - * The definition is the same as the one from JSON Schema, but references - * the Swagger Schema Object definition instead. - * - * - If true, additional properties of any type are allowed - * - If false, no additional properties are allowed - * - If a schema, additional properties must conform to that schema - * - * @example true - * @example false - * @example { type: "string" } - * @example { $ref: "#/definitions/AdditionalProperty" } - */ - additionalProperties?: boolean | Schema; // Forward declaration to avoid circular imports + /** + * Additional properties for the object. Can be a boolean or a schema. + * The definition is the same as the one from JSON Schema, but references + * the Swagger Schema Object definition instead. + * + * - If true, additional properties of any type are allowed + * - If false, no additional properties are allowed + * - If a schema, additional properties must conform to that schema + * + * @example true + * @example false + * @example { type: "string" } + * @example { $ref: "#/definitions/AdditionalProperty" } + */ + additionalProperties?: boolean | Schema; // Forward declaration to avoid circular imports - /** - * An array of schemas that this schema must validate against. - * All schemas in the array must be valid for the object to be valid. - * The definition is the same as the one from JSON Schema, but references - * the Swagger Schema Object definition instead. - * - * This enables schema composition and inheritance patterns, allowing - * objects to extend or combine multiple base schemas. - * - * @example [{ $ref: "#/definitions/BaseUser" }, { type: "object", properties: { ... } }] - * @example [{ $ref: "#/definitions/Identifiable" }, { $ref: "#/definitions/Timestamped" }] - */ - allOf?: Schema[]; // Forward declaration to avoid circular imports + /** + * An array of schemas that this schema must validate against. + * All schemas in the array must be valid for the object to be valid. + * The definition is the same as the one from JSON Schema, but references + * the Swagger Schema Object definition instead. + * + * This enables schema composition and inheritance patterns, allowing + * objects to extend or combine multiple base schemas. + * + * @example [{ $ref: "#/definitions/BaseUser" }, { type: "object", properties: { ... } }] + * @example [{ $ref: "#/definitions/Identifiable" }, { $ref: "#/definitions/Timestamped" }] + */ + allOf?: Schema[]; // Forward declaration to avoid circular imports - /** - * An object is valid against "maxProperties" if its number of properties is less than or equal to this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.1 | JSON Schema Validation - maxProperties} - * - * @example 10 - * @example 50 - */ - maxProperties?: number; + /** + * An object is valid against "maxProperties" if its number of properties is less than or equal to this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.1 | JSON Schema Validation - maxProperties} + * + * @example 10 + * @example 50 + */ + maxProperties?: number; - /** - * An object is valid against "minProperties" if its number of properties is greater than or equal to this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.2 | JSON Schema Validation - minProperties} - * - * @example 1 - * @example 2 - */ - minProperties?: number; + /** + * An object is valid against "minProperties" if its number of properties is greater than or equal to this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.4.2 | JSON Schema Validation - minProperties} + * + * @example 1 + * @example 2 + */ + minProperties?: number; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * @example { name: "user", attribute: false } - */ - xml?: XMLObject; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * @example { name: "user", attribute: false } + */ + xml?: XMLObject; } diff --git a/2.0/data-types/string.ts b/2.0/data-types/string.ts index bc5cf25..30c72c1 100644 --- a/2.0/data-types/string.ts +++ b/2.0/data-types/string.ts @@ -92,143 +92,143 @@ import type { XMLObject } from "../xml"; * ``` */ export interface StringSchema extends Extension { - /** - * The type of the schema. Must be "string" for string schemas. - * - * This property is required and must be set to "string" to indicate - * that this schema represents string data. - * - * @see {@link https://swagger.io/specification/v2/#data-types | Swagger 2.0 Specification - type} - * - * @example "string" - */ - type: "string"; + /** + * The type of the schema. Must be "string" for string schemas. + * + * This property is required and must be set to "string" to indicate + * that this schema represents string data. + * + * @see {@link https://swagger.io/specification/v2/#data-types | Swagger 2.0 Specification - type} + * + * @example "string" + */ + type: "string"; - /** - * The extending format for the previously mentioned type. - * See Swagger 2.0 Data Type Formats for further details. - * - * Formats provide additional semantic information about the data type, - * enabling more precise validation and better tooling support. Swagger 2.0 - * defines several standard formats, but custom formats are also allowed. - * - * @see {@link https://swagger.io/specification/v2/#dataTypeFormat | Swagger 2.0 Data Type Formats} - * - * @example "int32" - * @example "date" - * @example "email" - * @example "uuid" - */ - format?: string; + /** + * The extending format for the previously mentioned type. + * See Swagger 2.0 Data Type Formats for further details. + * + * Formats provide additional semantic information about the data type, + * enabling more precise validation and better tooling support. Swagger 2.0 + * defines several standard formats, but custom formats are also allowed. + * + * @see {@link https://swagger.io/specification/v2/#dataTypeFormat | Swagger 2.0 Data Type Formats} + * + * @example "int32" + * @example "date" + * @example "email" + * @example "uuid" + */ + format?: string; - /** - * A short description of the schema. GFM syntax can be used for rich text representation. - * - * This description should provide clear information about what the schema - * represents and how it should be used. It's commonly displayed in API - * documentation and code generation tools. - * - * @see {@link https://swagger.io/specification/v2/#schema-object | Swagger 2.0 Specification - description} - * - * @example "A user object containing basic information" - * @example "Email address in RFC 5322 format" - */ - description?: string; + /** + * A short description of the schema. GFM syntax can be used for rich text representation. + * + * This description should provide clear information about what the schema + * represents and how it should be used. It's commonly displayed in API + * documentation and code generation tools. + * + * @see {@link https://swagger.io/specification/v2/#schema-object | Swagger 2.0 Specification - description} + * + * @example "A user object containing basic information" + * @example "Email address in RFC 5322 format" + */ + description?: string; - /** - * A short title for the schema. - * - * The title provides a human-readable name for the schema, often used - * in documentation and UI displays. It should be concise but descriptive. - * - * @see {@link https://swagger.io/specification/v2/#schema-object | Swagger 2.0 Specification - title} - * - * @example "User" - * @example "Pet" - * @example "Order" - */ - title?: string; + /** + * A short title for the schema. + * + * The title provides a human-readable name for the schema, often used + * in documentation and UI displays. It should be concise but descriptive. + * + * @see {@link https://swagger.io/specification/v2/#schema-object | Swagger 2.0 Specification - title} + * + * @example "User" + * @example "Pet" + * @example "Order" + */ + title?: string; - /** - * Declares the value of the schema that the server will use if none is provided. - * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. - * - * This is a Swagger 2.0 specific requirement that differs from JSON Schema. - * The default value must be valid according to the schema's type and constraints. - * - * @see {@link https://swagger.io/specification/v2/#schema-object | Swagger 2.0 Specification - default} - * - * @example "defaultValue" - * @example 10 - * @example { name: "John", age: 30 } - * @example ["item1", "item2"] - */ - default?: unknown; + /** + * Declares the value of the schema that the server will use if none is provided. + * Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object. + * + * This is a Swagger 2.0 specific requirement that differs from JSON Schema. + * The default value must be valid according to the schema's type and constraints. + * + * @see {@link https://swagger.io/specification/v2/#schema-object | Swagger 2.0 Specification - default} + * + * @example "defaultValue" + * @example 10 + * @example { name: "John", age: 30 } + * @example ["item1", "item2"] + */ + default?: unknown; - /** - * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 | JSON Schema Validation - enum} - * - * @example ["option1", "option2", "option3"] - * @example ["red", "green", "blue"] - * @example [1, 2, 3, 4, 5] - */ - enum?: unknown[]; + /** + * An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 | JSON Schema Validation - enum} + * + * @example ["option1", "option2", "option3"] + * @example ["red", "green", "blue"] + * @example [1, 2, 3, 4, 5] + */ + enum?: unknown[]; - /** - * A free-form property to include an example of an instance for this schema. - * - * Examples help developers understand how to use the schema and what kind - * of data is expected. They are commonly used by documentation generators - * and API testing tools. - * - * @see {@link https://swagger.io/specification/v2/#schema-object | Swagger 2.0 Specification - example} - * - * @example { name: "Puma", id: 1 } - * @example "example string value" - * @example 42 - * @example ["item1", "item2"] - */ - example?: unknown; + /** + * A free-form property to include an example of an instance for this schema. + * + * Examples help developers understand how to use the schema and what kind + * of data is expected. They are commonly used by documentation generators + * and API testing tools. + * + * @see {@link https://swagger.io/specification/v2/#schema-object | Swagger 2.0 Specification - example} + * + * @example { name: "Puma", id: 1 } + * @example "example string value" + * @example 42 + * @example ["item1", "item2"] + */ + example?: unknown; - /** - * A string is valid against "maxLength" if its length is less than or equal to this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1 | JSON Schema Validation - maxLength} - * - * @example 100 - * @example 255 - */ - maxLength?: number; + /** + * A string is valid against "maxLength" if its length is less than or equal to this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1 | JSON Schema Validation - maxLength} + * + * @example 100 + * @example 255 + */ + maxLength?: number; - /** - * A string is valid against "minLength" if its length is greater than or equal to this value. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2 | JSON Schema Validation - minLength} - * - * @example 1 - * @example 8 - */ - minLength?: number; + /** + * A string is valid against "minLength" if its length is greater than or equal to this value. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2 | JSON Schema Validation - minLength} + * + * @example 1 + * @example 8 + */ + minLength?: number; - /** - * A string is valid against "pattern" if the regular expression matches the string successfully. - * The regular expression syntax follows ECMA 262. - * - * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3 | JSON Schema Validation - pattern} - * @see {@link https://www.ecma-international.org/ecma-262/5.1/#sec-15.10 | ECMA 262 Regular Expression Syntax} - * - * @example "^[a-zA-Z0-9]+$" - * @example "^\\d{4}-\\d{2}-\\d{2}$" - */ - pattern?: string; + /** + * A string is valid against "pattern" if the regular expression matches the string successfully. + * The regular expression syntax follows ECMA 262. + * + * @see {@link https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3 | JSON Schema Validation - pattern} + * @see {@link https://www.ecma-international.org/ecma-262/5.1/#sec-15.10 | ECMA 262 Regular Expression Syntax} + * + * @example "^[a-zA-Z0-9]+$" + * @example "^\\d{4}-\\d{2}-\\d{2}$" + */ + pattern?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * @example { name: "userName", attribute: false } - */ - xml?: XMLObject; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * @example { name: "userName", attribute: false } + */ + xml?: XMLObject; } diff --git a/2.0/example.ts b/2.0/example.ts index dd0070f..cf633ed 100644 --- a/2.0/example.ts +++ b/2.0/example.ts @@ -59,17 +59,17 @@ import type { Extension } from "./extensions"; * ``` */ export interface Examples extends Extension { - /** - * The name of the property MUST be one of the Operation produces values - * (either implicit or inherited). The value SHOULD be an example of what - * such a response would look like. - * - * The property name corresponds to a MIME type that the operation can produce. - * The value should be a realistic example of the response data in that format. - * - * @example { "application/json": { name: "Puma", type: "Dog" } } - * @example { "application/xml": "Puma" } - * @example { "text/plain": "Success" } - */ - [mimeType: string]: unknown; + /** + * The name of the property MUST be one of the Operation produces values + * (either implicit or inherited). The value SHOULD be an example of what + * such a response would look like. + * + * The property name corresponds to a MIME type that the operation can produce. + * The value should be a realistic example of the response data in that format. + * + * @example { "application/json": { name: "Puma", type: "Dog" } } + * @example { "application/xml": "Puma" } + * @example { "text/plain": "Success" } + */ + [mimeType: string]: unknown; } diff --git a/2.0/extensions.ts b/2.0/extensions.ts index ae95915..846b9fe 100644 --- a/2.0/extensions.ts +++ b/2.0/extensions.ts @@ -96,20 +96,20 @@ * ``` */ export type Extension = { - /** - * Vendor extensions allow adding custom properties to Swagger objects. - * All extension property names MUST begin with "x-" followed by any valid identifier. - * The value can be any valid JSON value (null, primitive, array, or object). - * - * Extensions enable API providers to add custom functionality and metadata - * to their specifications without breaking compatibility with standard - * Swagger tools. They should be used consistently and documented properly. - * - * @example { "x-internal-id": "12345" } - * @example { "x-custom-feature": { enabled: true, version: "1.0" } } - * @example { "x-tags": ["internal", "beta"] } - * @example { "x-deprecated": true } - * @example { "x-optional-field": null } - */ - [K in `x-${string}`]: unknown; + /** + * Vendor extensions allow adding custom properties to Swagger objects. + * All extension property names MUST begin with "x-" followed by any valid identifier. + * The value can be any valid JSON value (null, primitive, array, or object). + * + * Extensions enable API providers to add custom functionality and metadata + * to their specifications without breaking compatibility with standard + * Swagger tools. They should be used consistently and documented properly. + * + * @example { "x-internal-id": "12345" } + * @example { "x-custom-feature": { enabled: true, version: "1.0" } } + * @example { "x-tags": ["internal", "beta"] } + * @example { "x-deprecated": true } + * @example { "x-optional-field": null } + */ + [K in `x-${string}`]: unknown; }; diff --git a/2.0/externalDocs.ts b/2.0/externalDocs.ts index e1a4417..a66cfca 100644 --- a/2.0/externalDocs.ts +++ b/2.0/externalDocs.ts @@ -84,36 +84,36 @@ import type { Extension } from "./extensions"; * ``` */ export interface ExternalDocumentation extends Extension { - /** - * A short description of the target documentation. GFM syntax can be used for - * rich text representation. - * - * This description provides context about what the external documentation - * contains and helps developers understand when and why they should - * reference it. - * - * @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - description} - * - * @example "Find more info here" - * @example "Complete API documentation with examples and tutorials" - * @example "SDK documentation and code examples" - * @example "Step-by-step integration guide" - */ - description?: string; + /** + * A short description of the target documentation. GFM syntax can be used for + * rich text representation. + * + * This description provides context about what the external documentation + * contains and helps developers understand when and why they should + * reference it. + * + * @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - description} + * + * @example "Find more info here" + * @example "Complete API documentation with examples and tutorials" + * @example "SDK documentation and code examples" + * @example "Step-by-step integration guide" + */ + description?: string; - /** - * The URL for the target documentation. Value MUST be in the format of a URL. - * This field is required. - * - * The URL should point to a valid, accessible resource that provides - * additional documentation about the API or specific aspects of it. - * - * @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - url} - * - * @example "https://swagger.io" - * @example "https://docs.example.com/api" - * @example "https://github.com/example/sdk" - * @example "https://example.com/integration-guide" - */ - url: string; + /** + * The URL for the target documentation. Value MUST be in the format of a URL. + * This field is required. + * + * The URL should point to a valid, accessible resource that provides + * additional documentation about the API or specific aspects of it. + * + * @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - url} + * + * @example "https://swagger.io" + * @example "https://docs.example.com/api" + * @example "https://github.com/example/sdk" + * @example "https://example.com/integration-guide" + */ + url: string; } diff --git a/2.0/index.ts b/2.0/index.ts index 31f6094..5c37925 100644 --- a/2.0/index.ts +++ b/2.0/index.ts @@ -2,67 +2,67 @@ // This file serves as the main entry point for all OpenAPI 2.0 type definitions export type { - ArraySchema, - BooleanSchema, - FileSchema, - IntegerSchema, - NumberSchema, - ObjectSchema, - // Individual schema types - StringSchema, + ArraySchema, + BooleanSchema, + FileSchema, + IntegerSchema, + NumberSchema, + ObjectSchema, + // Individual schema types + StringSchema, } from "./data-types"; export type { Examples } from "./example"; // Re-export all types for convenience export type { - // Core types - Extension, + // Core types + Extension, } from "./extensions"; export type { ExternalDocumentation } from "./externalDocs"; export type { - Contact, - // Info types - Info, - License, + Contact, + // Info types + Info, + License, } from "./info"; export type { - Header, - Items, - Operation, - Parameter, - // Path types - PathItem, - Paths, - Response, + Header, + Items, + Operation, + Parameter, + // Path types + PathItem, + Paths, + Response, } from "./paths"; export type { - // References - BaseReference, - Reference, + // References + BaseReference, + Reference, } from "./references"; export type { - Definitions, - ParametersDefinitions, - ResponsesDefinitions, - // Schema types - Schema, - XML, + Definitions, + ParametersDefinitions, + ResponsesDefinitions, + // Schema types + Schema, + XML, } from "./schema"; export type { - Scopes, - SecurityDefinitions, - SecurityRequirement, - // Security types - SecurityScheme, + Scopes, + SecurityDefinitions, + SecurityRequirement, + // Security types + SecurityScheme, } from "./security"; // Export the main specification type export type { Specification } from "./spec"; export type { - // Utility types - Tag, + // Utility types + Tag, } from "./tags"; export type { - // XML Object - XMLObject, + // XML Object + XMLObject, } from "./xml"; // All supporting types are now defined in their respective modules: diff --git a/2.0/info.ts b/2.0/info.ts index 0989cb8..e88f7a6 100644 --- a/2.0/info.ts +++ b/2.0/info.ts @@ -27,64 +27,64 @@ import type { Extension } from "./extensions"; * ``` */ export interface Info extends Extension { - /** - * The title of the application. This field is required. - * - * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - title} - * - * @example "Swagger Sample App" - * @example "My API" - */ - title: string; + /** + * The title of the application. This field is required. + * + * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - title} + * + * @example "Swagger Sample App" + * @example "My API" + */ + title: string; - /** - * A short description of the application. GFM syntax can be used for rich text representation. - * - * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - description} - * - * @example "This is a sample server Petstore server." - * @example "A comprehensive API for managing user data" - */ - description?: string; + /** + * A short description of the application. GFM syntax can be used for rich text representation. + * + * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - description} + * + * @example "This is a sample server Petstore server." + * @example "A comprehensive API for managing user data" + */ + description?: string; - /** - * The Terms of Service for the API. - * - * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - termsOfService} - * - * @example "http://swagger.io/terms/" - * @example "https://example.com/terms" - */ - termsOfService?: string; + /** + * The Terms of Service for the API. + * + * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - termsOfService} + * + * @example "http://swagger.io/terms/" + * @example "https://example.com/terms" + */ + termsOfService?: string; - /** - * The contact information for the exposed API. - * - * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - contact} - * - * @example { name: "API Support", email: "support@example.com" } - */ - contact?: Contact; + /** + * The contact information for the exposed API. + * + * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - contact} + * + * @example { name: "API Support", email: "support@example.com" } + */ + contact?: Contact; - /** - * The license information for the exposed API. - * - * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - license} - * - * @example { name: "Apache 2.0", url: "http://www.apache.org/licenses/LICENSE-2.0.html" } - */ - license?: License; + /** + * The license information for the exposed API. + * + * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - license} + * + * @example { name: "Apache 2.0", url: "http://www.apache.org/licenses/LICENSE-2.0.html" } + */ + license?: License; - /** - * Provides the version of the application API (not to be confused with the specification version). - * This field is required. - * - * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - version} - * - * @example "1.0.1" - * @example "2.0.0" - */ - version: string; + /** + * Provides the version of the application API (not to be confused with the specification version). + * This field is required. + * + * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - version} + * + * @example "1.0.1" + * @example "2.0.0" + */ + version: string; } /** @@ -103,35 +103,35 @@ export interface Info extends Extension { * ``` */ export interface Contact extends Extension { - /** - * The identifying name of the contact person/organization. - * - * @see {@link https://swagger.io/specification/v2/#contact-object | Swagger 2.0 Specification - name} - * - * @example "API Support" - * @example "John Doe" - */ - name?: string; + /** + * The identifying name of the contact person/organization. + * + * @see {@link https://swagger.io/specification/v2/#contact-object | Swagger 2.0 Specification - name} + * + * @example "API Support" + * @example "John Doe" + */ + name?: string; - /** - * The URL pointing to the contact information. MUST be in the format of a URL. - * - * @see {@link https://swagger.io/specification/v2/#contact-object | Swagger 2.0 Specification - url} - * - * @example "http://www.swagger.io/support" - * @example "https://example.com/contact" - */ - url?: string; + /** + * The URL pointing to the contact information. MUST be in the format of a URL. + * + * @see {@link https://swagger.io/specification/v2/#contact-object | Swagger 2.0 Specification - url} + * + * @example "http://www.swagger.io/support" + * @example "https://example.com/contact" + */ + url?: string; - /** - * The email address of the contact person/organization. MUST be in the format of an email address. - * - * @see {@link https://swagger.io/specification/v2/#contact-object | Swagger 2.0 Specification - email} - * - * @example "support@swagger.io" - * @example "contact@example.com" - */ - email?: string; + /** + * The email address of the contact person/organization. MUST be in the format of an email address. + * + * @see {@link https://swagger.io/specification/v2/#contact-object | Swagger 2.0 Specification - email} + * + * @example "support@swagger.io" + * @example "contact@example.com" + */ + email?: string; } /** @@ -202,25 +202,25 @@ export interface Contact extends Extension { * ``` */ export interface License extends Extension { - /** - * The license name used for the API. This field is required. - * - * @see {@link https://swagger.io/specification/v2/#license-object | Swagger 2.0 Specification - name} - * - * @example "MIT License" - * @example "Apache License 2.0" - * @example "Proprietary Foo License" - */ - name: string; + /** + * The license name used for the API. This field is required. + * + * @see {@link https://swagger.io/specification/v2/#license-object | Swagger 2.0 Specification - name} + * + * @example "MIT License" + * @example "Apache License 2.0" + * @example "Proprietary Foo License" + */ + name: string; - /** - * A URL to the license used for the API. MUST be in the format of a URL. - * - * @see {@link https://swagger.io/specification/v2/#license-object | Swagger 2.0 Specification - url} - * - * @example "https://opensource.org/license/mit/" - * @example "https://www.apache.org/licenses/LICENSE-2.0" - * @example "https://example.com/licenses/foo-1.0" - */ - url?: string; + /** + * A URL to the license used for the API. MUST be in the format of a URL. + * + * @see {@link https://swagger.io/specification/v2/#license-object | Swagger 2.0 Specification - url} + * + * @example "https://opensource.org/license/mit/" + * @example "https://www.apache.org/licenses/LICENSE-2.0" + * @example "https://example.com/licenses/foo-1.0" + */ + url?: string; } diff --git a/2.0/paths.ts b/2.0/paths.ts index db8e40e..6635caa 100644 --- a/2.0/paths.ts +++ b/2.0/paths.ts @@ -55,83 +55,83 @@ import type { ResponsesMap } from "./status"; * ``` */ export type PathItem = - | ({ - /** - * A definition of a GET operation on this path. - * - * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - get} - * - * @example { summary: "Get users", responses: { "200": { description: "Success" } } } - */ - get?: Operation; + | ({ + /** + * A definition of a GET operation on this path. + * + * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - get} + * + * @example { summary: "Get users", responses: { "200": { description: "Success" } } } + */ + get?: Operation; - /** - * A definition of a PUT operation on this path. - * - * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - put} - * - * @example { summary: "Update user", responses: { "200": { description: "Success" } } } - */ - put?: Operation; + /** + * A definition of a PUT operation on this path. + * + * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - put} + * + * @example { summary: "Update user", responses: { "200": { description: "Success" } } } + */ + put?: Operation; - /** - * A definition of a POST operation on this path. - * - * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - post} - * - * @example { summary: "Create user", responses: { "201": { description: "Created" } } } - */ - post?: Operation; + /** + * A definition of a POST operation on this path. + * + * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - post} + * + * @example { summary: "Create user", responses: { "201": { description: "Created" } } } + */ + post?: Operation; - /** - * A definition of a DELETE operation on this path. - * - * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - delete} - * - * @example { summary: "Delete user", responses: { "204": { description: "No Content" } } } - */ - delete?: Operation; + /** + * A definition of a DELETE operation on this path. + * + * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - delete} + * + * @example { summary: "Delete user", responses: { "204": { description: "No Content" } } } + */ + delete?: Operation; - /** - * A definition of an OPTIONS operation on this path. - * - * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - options} - * - * @example { summary: "Get options", responses: { "200": { description: "Options" } } } - */ - options?: Operation; + /** + * A definition of an OPTIONS operation on this path. + * + * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - options} + * + * @example { summary: "Get options", responses: { "200": { description: "Options" } } } + */ + options?: Operation; - /** - * A definition of a HEAD operation on this path. - * - * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - head} - * - * @example { summary: "Check if resource exists", responses: { "200": { description: "Exists" } } } - */ - head?: Operation; + /** + * A definition of a HEAD operation on this path. + * + * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - head} + * + * @example { summary: "Check if resource exists", responses: { "200": { description: "Exists" } } } + */ + head?: Operation; - /** - * A definition of a PATCH operation on this path. - * - * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - patch} - * - * @example { summary: "Partially update user", responses: { "200": { description: "Success" } } } - */ - patch?: Operation; + /** + * A definition of a PATCH operation on this path. + * + * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - patch} + * + * @example { summary: "Partially update user", responses: { "200": { description: "Success" } } } + */ + patch?: Operation; - /** - * 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. - * - * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - parameters} - * - * @example [{ name: "limit", in: "query", type: "integer" }] - */ - parameters?: Array; - } & Extension) - | BaseReference; + /** + * 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. + * + * @see {@link https://swagger.io/specification/v2/#path-item-object | Swagger 2.0 Specification - parameters} + * + * @example [{ name: "limit", in: "query", type: "integer" }] + */ + parameters?: Array; + } & Extension) + | BaseReference; /** * Operation Object @@ -173,142 +173,142 @@ export type PathItem = * ``` */ export interface Operation extends Extension { - /** - * A list of tags for API documentation control. Tags can be used for logical - * grouping of operations by resources or any other qualifier. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - tags} - * - * @example ["users", "authentication"] - * @example ["pets"] - */ - tags?: string[]; + /** + * A list of tags for API documentation control. Tags can be used for logical + * grouping of operations by resources or any other qualifier. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - tags} + * + * @example ["users", "authentication"] + * @example ["pets"] + */ + tags?: string[]; - /** - * A short summary of what the operation does. For maximum readability in - * swagger-ui, this field SHOULD be less than 120 characters. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - summary} - * - * @example "Get user by ID" - * @example "Create a new pet" - */ - summary?: string; + /** + * A short summary of what the operation does. For maximum readability in + * swagger-ui, this field SHOULD be less than 120 characters. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - summary} + * + * @example "Get user by ID" + * @example "Create a new pet" + */ + summary?: string; - /** - * A verbose explanation of the operation behavior. GFM syntax can be used - * for rich text representation. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - description} - * - * @example "Retrieves a specific user by their unique identifier. Returns user details including name, email, and profile information." - */ - description?: string; + /** + * A verbose explanation of the operation behavior. GFM syntax can be used + * for rich text representation. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - description} + * + * @example "Retrieves a specific user by their unique identifier. Returns user details including name, email, and profile information." + */ + description?: string; - /** - * Additional external documentation for this operation. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - externalDocs} - * - * @example { description: "Find out more about this operation", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for this operation. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - externalDocs} + * + * @example { description: "Find out more about this operation", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * 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. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - operationId} - * - * @example "getUserById" - * @example "createPet" - */ - operationId?: string; + /** + * 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. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - operationId} + * + * @example "getUserById" + * @example "createPet" + */ + operationId?: string; - /** - * A list of MIME types the operation can consume. This overrides the consumes - * definition at the Swagger Object level. An empty value MAY be used to clear - * the global definition. Value MUST be as described under Mime Types. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - consumes} - * - * @example ["application/json"] - * @example ["application/xml", "application/json"] - */ - consumes?: string[]; + /** + * A list of MIME types the operation can consume. This overrides the consumes + * definition at the Swagger Object level. An empty value MAY be used to clear + * the global definition. Value MUST be as described under Mime Types. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - consumes} + * + * @example ["application/json"] + * @example ["application/xml", "application/json"] + */ + consumes?: string[]; - /** - * A list of MIME types the operation can produce. This overrides the produces - * definition at the Swagger Object level. An empty value MAY be used to clear - * the global definition. Value MUST be as described under Mime Types. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - produces} - * - * @example ["application/json"] - * @example ["application/xml", "application/json"] - */ - produces?: string[]; + /** + * A list of MIME types the operation can produce. This overrides the produces + * definition at the Swagger Object level. An empty value MAY be used to clear + * the global definition. Value MUST be as described under Mime Types. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - produces} + * + * @example ["application/json"] + * @example ["application/xml", "application/json"] + */ + produces?: string[]; - /** - * A list of parameters that are applicable for this operation. If a parameter - * is already defined at the Path Item, the new definition will override it - * but can never remove it. The list MUST NOT include duplicated parameters. - * A unique parameter is defined by a combination of a name and location. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - parameters} - * - * @example [{ name: "id", in: "path", required: true, type: "string" }] - */ - parameters?: Array; + /** + * A list of parameters that are applicable for this operation. If a parameter + * is already defined at the Path Item, the new definition will override it + * but can never remove it. The list MUST NOT include duplicated parameters. + * A unique parameter is defined by a combination of a name and location. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - parameters} + * + * @example [{ name: "id", in: "path", required: true, type: "string" }] + */ + parameters?: Array; - /** - * The list of possible responses as they are returned from executing this operation. - * This field MUST be present and MUST contain at least one response. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - responses} - * - * @example { "200": { description: "Success", schema: { type: "object" } } } - */ - responses: ResponsesMap; + /** + * The list of possible responses as they are returned from executing this operation. + * This field MUST be present and MUST contain at least one response. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - responses} + * + * @example { "200": { description: "Success", schema: { type: "object" } } } + */ + responses: ResponsesMap; - /** - * The transfer protocol for the operation. Values MUST be from the list: - * "http", "https", "ws", "wss". The value overrides the Swagger Object - * schemes definition. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - schemes} - * - * @example ["https", "http"] - * @example ["wss"] - */ - schemes?: Array<"http" | "https" | "ws" | "wss">; + /** + * The transfer protocol for the operation. Values MUST be from the list: + * "http", "https", "ws", "wss". The value overrides the Swagger Object + * schemes definition. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - schemes} + * + * @example ["https", "http"] + * @example ["wss"] + */ + schemes?: Array<"http" | "https" | "ws" | "wss">; - /** - * Declares this operation to be deprecated. Usage of the declared operation - * should be refrained. Default value is false. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - deprecated} - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Declares this operation to be deprecated. Usage of the declared operation + * should be refrained. Default value is false. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - deprecated} + * + * @default false + * @example true + */ + deprecated?: boolean; - /** - * A declaration of which security schemes are applied for this operation. - * The list of values describes alternative security schemes that can be used - * (that is, there is a logical OR between the security requirements). - * This definition overrides any declared top-level security. To remove a - * top-level security declaration, an empty array can be used. - * - * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - security} - * - * @example [{ "api_key": [] }] - * @example [{ "oauth2": ["read", "write"] }] - */ - security?: Array>; + /** + * A declaration of which security schemes are applied for this operation. + * The list of values describes alternative security schemes that can be used + * (that is, there is a logical OR between the security requirements). + * This definition overrides any declared top-level security. To remove a + * top-level security declaration, an empty array can be used. + * + * @see {@link https://swagger.io/specification/v2/#operation-object | Swagger 2.0 Specification - security} + * + * @example [{ "api_key": [] }] + * @example [{ "oauth2": ["read", "write"] }] + */ + security?: Array>; } /** @@ -413,58 +413,58 @@ export interface Operation extends Extension { * ``` */ export interface BodyParameter extends Extension { - /** - * The name of the parameter. For body parameters, this is used for documentation - * purposes only and has no effect on the parameter itself. - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - name} - * - * @example "user" - * @example "data" - * @example "payload" - */ - name: string; + /** + * The name of the parameter. For body parameters, this is used for documentation + * purposes only and has no effect on the parameter itself. + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - name} + * + * @example "user" + * @example "data" + * @example "payload" + */ + name: string; - /** - * The location of the parameter. Must be "body" for body parameters. - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - in} - * - * @example "body" - */ - in: "body"; + /** + * The location of the parameter. Must be "body" for body parameters. + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - in} + * + * @example "body" + */ + in: "body"; - /** - * A brief description of the parameter. This could contain examples of use. - * GFM syntax can be used for rich text representation. - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - description} - * - * @example "User object to create" - * @example "Request payload containing the data to process" - */ - description?: string; + /** + * A brief description of the parameter. This could contain examples of use. + * GFM syntax can be used for rich text representation. + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - description} + * + * @example "User object to create" + * @example "Request payload containing the data to process" + */ + description?: string; - /** - * Determines whether this parameter is mandatory. Default value is false. - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - required} - * - * @default false - * @example true - */ - required?: boolean; + /** + * Determines whether this parameter is mandatory. Default value is false. + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - required} + * + * @default false + * @example true + */ + required?: boolean; - /** - * The schema defining the type used for the body parameter. This property is - * required for body parameters. - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - schema} - * - * @example { $ref: "#/definitions/User" } - * @example { type: "object", properties: { name: { type: "string" } } } - */ - schema: Schema; + /** + * The schema defining the type used for the body parameter. This property is + * required for body parameters. + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - schema} + * + * @example { $ref: "#/definitions/User" } + * @example { type: "object", properties: { name: { type: "string" } } } + */ + schema: Schema; } /** @@ -566,208 +566,208 @@ export interface BodyParameter extends Extension { * ``` */ export interface NonBodyParameter extends Extension { - /** - * The name of the parameter. Parameter names are case sensitive. - * - If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object - * - For all other cases, the name corresponds to the parameter name used by the in property - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - name} - * - * @example "id" - * @example "limit" - * @example "user" - */ - name: string; + /** + * The name of the parameter. Parameter names are case sensitive. + * - If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object + * - For all other cases, the name corresponds to the parameter name used by the in property + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - name} + * + * @example "id" + * @example "limit" + * @example "user" + */ + name: string; - /** - * The location of the parameter. Possible values are "query", "header", "path", or "formData". - * - * - **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin. - * - **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. - * - **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. - * - **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request. - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - in} - * - * @example "query" - * @example "path" - * @example "header" - * @example "formData" - */ - in: "query" | "header" | "path" | "formData"; + /** + * The location of the parameter. Possible values are "query", "header", "path", or "formData". + * + * - **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin. + * - **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive. + * - **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. + * - **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request. + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - in} + * + * @example "query" + * @example "path" + * @example "header" + * @example "formData" + */ + in: "query" | "header" | "path" | "formData"; - /** - * A brief description of the parameter. This could contain examples of use. - * GFM syntax can be used for rich text representation. - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - description} - * - * @example "The user ID" - * @example "Maximum number of items to return (default: 10)" - */ - description?: string; + /** + * A brief description of the parameter. This could contain examples of use. + * GFM syntax can be used for rich text representation. + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - description} + * + * @example "The user ID" + * @example "Maximum number of items to return (default: 10)" + */ + description?: string; - /** - * Determines whether this parameter is mandatory. If the parameter is in "path", - * this property is required and its value MUST be true. Otherwise, the property - * MAY be included and its default value is false. - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - required} - * - * @default false - * @example true - */ - required?: boolean; + /** + * Determines whether this parameter is mandatory. If the parameter is in "path", + * this property is required and its value MUST be true. Otherwise, the property + * MAY be included and its default value is false. + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - required} + * + * @default false + * @example true + */ + required?: boolean; - /** - * The type of the parameter. Since the parameter is not located at the request body, - * it is limited to simple types (that is, not an object). The value MUST be one of - * "string", "number", "integer", "boolean", "array" or "file". If type is "file", - * the consumes MUST be either "multipart/form-data", "application/x-www-form-urlencoded" - * or both and the parameter MUST be in "formData". - * - * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - type} - * - * @example "string" - * @example "integer" - * @example "array" - * @example "file" - */ - type: "string" | "number" | "integer" | "boolean" | "array" | "file"; + /** + * The type of the parameter. Since the parameter is not located at the request body, + * it is limited to simple types (that is, not an object). The value MUST be one of + * "string", "number", "integer", "boolean", "array" or "file". If type is "file", + * the consumes MUST be either "multipart/form-data", "application/x-www-form-urlencoded" + * or both and the parameter MUST be in "formData". + * + * @see {@link https://swagger.io/specification/v2/#parameter-object | Swagger 2.0 Specification - type} + * + * @example "string" + * @example "integer" + * @example "array" + * @example "file" + */ + type: "string" | "number" | "integer" | "boolean" | "array" | "file"; - /** - * The extending format for the previously mentioned type. See Data Type Formats - * for further details. - * - * @example "int32" - * @example "date" - * @example "email" - */ - format?: string; + /** + * The extending format for the previously mentioned type. See Data Type Formats + * for further details. + * + * @example "int32" + * @example "date" + * @example "email" + */ + format?: string; - /** - * Sets the ability to pass empty-valued parameters. This is valid only for either - * query or formData parameters and allows you to send a parameter with a name only - * or an empty value. Default value is false. - * - * @default false - * @example true - */ - allowEmptyValue?: boolean; + /** + * Sets the ability to pass empty-valued parameters. This is valid only for either + * query or formData parameters and allows you to send a parameter with a name only + * or an empty value. Default value is false. + * + * @default false + * @example true + */ + allowEmptyValue?: boolean; - /** - * Required if type is "array". Describes the type of items in the array. - * - * @example { type: "string" } - * @example { type: "integer", format: "int32" } - */ - items?: Items; + /** + * Required if type is "array". Describes the type of items in the array. + * + * @example { type: "string" } + * @example { type: "integer", format: "int32" } + */ + items?: Items; - /** - * Determines the format of the array if type array is used. Possible values are: - * - csv: comma separated values foo,bar - * - ssv: space separated values foo bar - * - tsv: tab separated values foo\tbar - * - pipes: pipe separated values foo|bar - * - multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz - * - * @default "csv" - * @example "multi" - */ - collectionFormat?: "csv" | "ssv" | "tsv" | "pipes" | "multi"; + /** + * Determines the format of the array if type array is used. Possible values are: + * - csv: comma separated values foo,bar + * - ssv: space separated values foo bar + * - tsv: tab separated values foo\tbar + * - pipes: pipe separated values foo|bar + * - multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz + * + * @default "csv" + * @example "multi" + */ + collectionFormat?: "csv" | "ssv" | "tsv" | "pipes" | "multi"; - /** - * Declares the value of the parameter that the server will use if none is provided. - * This value MUST conform to the defined type for this parameter. - * - * @example "defaultValue" - * @example 10 - */ - default?: unknown; + /** + * Declares the value of the parameter that the server will use if none is provided. + * This value MUST conform to the defined type for this parameter. + * + * @example "defaultValue" + * @example 10 + */ + default?: unknown; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 - * - * @example 100 - */ - maximum?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 + * + * @example 100 + */ + maximum?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 - * - * @example false - */ - exclusiveMaximum?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 + * + * @example false + */ + exclusiveMaximum?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 - * - * @example 0 - */ - minimum?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 + * + * @example 0 + */ + minimum?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 - * - * @example false - */ - exclusiveMinimum?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 + * + * @example false + */ + exclusiveMinimum?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1 - * - * @example 100 - */ - maxLength?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1 + * + * @example 100 + */ + maxLength?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2 - * - * @example 1 - */ - minLength?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2 + * + * @example 1 + */ + minLength?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3 - * - * @example "^[a-zA-Z0-9]+$" - */ - pattern?: string; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3 + * + * @example "^[a-zA-Z0-9]+$" + */ + pattern?: string; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2 - * - * @example 10 - */ - maxItems?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2 + * + * @example 10 + */ + maxItems?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3 - * - * @example 1 - */ - minItems?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3 + * + * @example 1 + */ + minItems?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4 - * - * @example true - */ - uniqueItems?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4 + * + * @example true + */ + uniqueItems?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 - * - * @example ["option1", "option2", "option3"] - */ - enum?: unknown[]; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 + * + * @example ["option1", "option2", "option3"] + */ + enum?: unknown[]; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1 - * - * @example 2 - */ - multipleOf?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1 + * + * @example 2 + */ + multipleOf?: number; } /** @@ -818,138 +818,138 @@ export type Paths = Record; * ``` */ export interface Items extends Extension { - /** - * The internal type of the array. The value MUST be one of "string", "number", - * "integer", "boolean", or "array". Files and models are not allowed. - * - * @example "string" - * @example "integer" - * @example "array" - */ - type: string; + /** + * The internal type of the array. The value MUST be one of "string", "number", + * "integer", "boolean", or "array". Files and models are not allowed. + * + * @example "string" + * @example "integer" + * @example "array" + */ + type: string; - /** - * The extending format for the previously mentioned type. See Data Type Formats - * for further details. - * - * @example "int32" - * @example "date" - * @example "email" - */ - format?: string; + /** + * The extending format for the previously mentioned type. See Data Type Formats + * for further details. + * + * @example "int32" + * @example "date" + * @example "email" + */ + format?: string; - /** - * Required if type is "array". Describes the type of items in the array. - * - * @example { type: "string" } - * @example { type: "integer", format: "int32" } - */ - items?: Items; + /** + * Required if type is "array". Describes the type of items in the array. + * + * @example { type: "string" } + * @example { type: "integer", format: "int32" } + */ + items?: Items; - /** - * Determines the format of the array if type array is used. Possible values are: - * - csv: comma separated values foo,bar - * - ssv: space separated values foo bar - * - tsv: tab separated values foo\tbar - * - pipes: pipe separated values foo|bar - * - * @default "csv" - * @example "multi" - */ - collectionFormat?: "csv" | "ssv" | "tsv" | "pipes"; + /** + * Determines the format of the array if type array is used. Possible values are: + * - csv: comma separated values foo,bar + * - ssv: space separated values foo bar + * - tsv: tab separated values foo\tbar + * - pipes: pipe separated values foo|bar + * + * @default "csv" + * @example "multi" + */ + collectionFormat?: "csv" | "ssv" | "tsv" | "pipes"; - /** - * Declares the value of the item that the server will use if none is provided. - * This value MUST conform to the defined type for the data type. - * - * @example "defaultValue" - * @example 10 - */ - default?: unknown; + /** + * Declares the value of the item that the server will use if none is provided. + * This value MUST conform to the defined type for the data type. + * + * @example "defaultValue" + * @example 10 + */ + default?: unknown; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 - * - * @example 100 - */ - maximum?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 + * + * @example 100 + */ + maximum?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 - * - * @example false - */ - exclusiveMaximum?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 + * + * @example false + */ + exclusiveMaximum?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 - * - * @example 0 - */ - minimum?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 + * + * @example 0 + */ + minimum?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 - * - * @example false - */ - exclusiveMinimum?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 + * + * @example false + */ + exclusiveMinimum?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1 - * - * @example 100 - */ - maxLength?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1 + * + * @example 100 + */ + maxLength?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2 - * - * @example 1 - */ - minLength?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2 + * + * @example 1 + */ + minLength?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3 - * - * @example "^[a-zA-Z0-9]+$" - */ - pattern?: string; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3 + * + * @example "^[a-zA-Z0-9]+$" + */ + pattern?: string; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2 - * - * @example 10 - */ - maxItems?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2 + * + * @example 10 + */ + maxItems?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3 - * - * @example 1 - */ - minItems?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3 + * + * @example 1 + */ + minItems?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4 - * - * @example true - */ - uniqueItems?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4 + * + * @example true + */ + uniqueItems?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 - * - * @example ["option1", "option2", "option3"] - */ - enum?: unknown[]; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 + * + * @example ["option1", "option2", "option3"] + */ + enum?: unknown[]; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1 - * - * @example 2 - */ - multipleOf?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1 + * + * @example 2 + */ + multipleOf?: number; } /** @@ -1016,44 +1016,44 @@ export interface Items extends Extension { * ``` */ export interface Response extends Extension { - /** - * A short description of the response. - * GitHub Flavored Markdown syntax can be used for rich text representation. - * - * See [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for more information about the syntax. - * This field is required. - * - * @example "User successfully retrieved" - * @example "Bad request - invalid input parameters" - * @example "Internal server error" - */ - description: string; + /** + * A short description of the response. + * GitHub Flavored Markdown syntax can be used for rich text representation. + * + * See [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for more information about the syntax. + * This field is required. + * + * @example "User successfully retrieved" + * @example "Bad request - invalid input parameters" + * @example "Internal server error" + */ + description: string; - /** - * A definition of the response structure. It can be a primitive, an array or an object. - * If this field does not exist, it means no content is returned as part of the response. - * As an extension to the Schema Object, its root type value may also be "file". - * This SHOULD be accompanied by a relevant produces mime-type. - * - * @example { $ref: "#/definitions/User" } - * @example { type: "array", items: { $ref: "#/definitions/User" } } - * @example { type: "string" } - */ - schema?: Schema; + /** + * A definition of the response structure. It can be a primitive, an array or an object. + * If this field does not exist, it means no content is returned as part of the response. + * As an extension to the Schema Object, its root type value may also be "file". + * This SHOULD be accompanied by a relevant produces mime-type. + * + * @example { $ref: "#/definitions/User" } + * @example { type: "array", items: { $ref: "#/definitions/User" } } + * @example { type: "string" } + */ + schema?: Schema; - /** - * A list of headers that are sent with the response. - * - * @example { "X-RateLimit-Limit": { type: "integer", description: "Rate limit" } } - */ - headers?: Record; + /** + * A list of headers that are sent with the response. + * + * @example { "X-RateLimit-Limit": { type: "integer", description: "Rate limit" } } + */ + headers?: Record; - /** - * An example of the response message. - * - * @example { "application/json": { id: 1, name: "John Doe" } } - */ - examples?: Examples; + /** + * An example of the response message. + * + * @example { "application/json": { id: 1, name: "John Doe" } } + */ + examples?: Examples; } /** @@ -1074,147 +1074,147 @@ export interface Response extends Extension { * ``` */ export interface Header extends Extension { - /** - * A brief description of the header. GFM syntax can be used for rich text representation. - * - * @example "Rate limit for the current period" - * @example "Content type of the response" - */ - description?: string; + /** + * A brief description of the header. GFM syntax can be used for rich text representation. + * + * @example "Rate limit for the current period" + * @example "Content type of the response" + */ + description?: string; - /** - * The type of the object. The value MUST be one of "string", "number", "integer", - * "boolean", or "array". - * This field is required. - * - * @example "string" - * @example "integer" - * @example "array" - */ - type: string; + /** + * The type of the object. The value MUST be one of "string", "number", "integer", + * "boolean", or "array". + * This field is required. + * + * @example "string" + * @example "integer" + * @example "array" + */ + type: string; - /** - * The extending format for the previously mentioned type. See Data Type Formats - * for further details. - * - * @example "int32" - * @example "date" - * @example "email" - */ - format?: string; + /** + * The extending format for the previously mentioned type. See Data Type Formats + * for further details. + * + * @example "int32" + * @example "date" + * @example "email" + */ + format?: string; - /** - * Required if type is "array". Describes the type of items in the array. - * - * @example { type: "string" } - * @example { type: "integer", format: "int32" } - */ - items?: Items; + /** + * Required if type is "array". Describes the type of items in the array. + * + * @example { type: "string" } + * @example { type: "integer", format: "int32" } + */ + items?: Items; - /** - * Determines the format of the array if type array is used. Possible values are: - * - csv: comma separated values foo,bar - * - ssv: space separated values foo bar - * - tsv: tab separated values foo\tbar - * - pipes: pipe separated values foo|bar - * - * @default "csv" - * @example "multi" - */ - collectionFormat?: "csv" | "ssv" | "tsv" | "pipes"; + /** + * Determines the format of the array if type array is used. Possible values are: + * - csv: comma separated values foo,bar + * - ssv: space separated values foo bar + * - tsv: tab separated values foo\tbar + * - pipes: pipe separated values foo|bar + * + * @default "csv" + * @example "multi" + */ + collectionFormat?: "csv" | "ssv" | "tsv" | "pipes"; - /** - * Declares the value of the header that the server will use if none is provided. - * This value MUST conform to the defined type for the header. - * - * @example "defaultValue" - * @example 10 - */ - default?: unknown; + /** + * Declares the value of the header that the server will use if none is provided. + * This value MUST conform to the defined type for the header. + * + * @example "defaultValue" + * @example 10 + */ + default?: unknown; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 - * - * @example 100 - */ - maximum?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 + * + * @example 100 + */ + maximum?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 - * - * @example false - */ - exclusiveMaximum?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2 + * + * @example false + */ + exclusiveMaximum?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 - * - * @example 0 - */ - minimum?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 + * + * @example 0 + */ + minimum?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 - * - * @example false - */ - exclusiveMinimum?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3 + * + * @example false + */ + exclusiveMinimum?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1 - * - * @example 100 - */ - maxLength?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1 + * + * @example 100 + */ + maxLength?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2 - * - * @example 1 - */ - minLength?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2 + * + * @example 1 + */ + minLength?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3 - * - * @example "^[a-zA-Z0-9]+$" - */ - pattern?: string; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3 + * + * @example "^[a-zA-Z0-9]+$" + */ + pattern?: string; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2 - * - * @example 10 - */ - maxItems?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2 + * + * @example 10 + */ + maxItems?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3 - * - * @example 1 - */ - minItems?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3 + * + * @example 1 + */ + minItems?: number; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4 - * - * @example true - */ - uniqueItems?: boolean; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4 + * + * @example true + */ + uniqueItems?: boolean; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 - * - * @example ["option1", "option2", "option3"] - */ - enum?: unknown[]; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1 + * + * @example ["option1", "option2", "option3"] + */ + enum?: unknown[]; - /** - * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1 - * - * @example 2 - */ - multipleOf?: number; + /** + * See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1 + * + * @example 2 + */ + multipleOf?: number; } export type Parameter = BodyParameter | NonBodyParameter; diff --git a/2.0/references.ts b/2.0/references.ts index 7a9c0be..429f858 100644 --- a/2.0/references.ts +++ b/2.0/references.ts @@ -82,24 +82,24 @@ import type { Extension } from "./extensions"; * ``` */ export interface BaseReference { - /** - * The reference string. This field is required. - * - * The reference string follows JSON Pointer syntax and can reference: - * - Definitions within the same document using "#/definitions/Name" - * - Parameters within the same document using "#/parameters/Name" - * - Responses within the same document using "#/responses/Name" - * - External files using relative or absolute URLs - * - Specific parts of external files using fragment identifiers - * - * @example "#/definitions/Pet" - * @example "#/parameters/skipParam" - * @example "#/responses/NotFound" - * @example "Pet.json" - * @example "definitions.json#/Pet" - * @example "https://api.example.com/schemas/User.json" - */ - $ref: string; + /** + * The reference string. This field is required. + * + * The reference string follows JSON Pointer syntax and can reference: + * - Definitions within the same document using "#/definitions/Name" + * - Parameters within the same document using "#/parameters/Name" + * - Responses within the same document using "#/responses/Name" + * - External files using relative or absolute URLs + * - Specific parts of external files using fragment identifiers + * + * @example "#/definitions/Pet" + * @example "#/parameters/skipParam" + * @example "#/responses/NotFound" + * @example "Pet.json" + * @example "definitions.json#/Pet" + * @example "https://api.example.com/schemas/User.json" + */ + $ref: string; } /** diff --git a/2.0/schema.ts b/2.0/schema.ts index 4ae6f01..d981eae 100644 --- a/2.0/schema.ts +++ b/2.0/schema.ts @@ -1,11 +1,11 @@ import type { - ArraySchema, - BooleanSchema, - FileSchema, - IntegerSchema, - NumberSchema, - ObjectSchema, - StringSchema, + ArraySchema, + BooleanSchema, + FileSchema, + IntegerSchema, + NumberSchema, + ObjectSchema, + StringSchema, } from "./data-types"; import type { BaseReference } from "./references"; import type { XMLObject } from "./xml"; @@ -149,14 +149,14 @@ import type { XMLObject } from "./xml"; * ``` */ export type Schema = - | StringSchema - | NumberSchema - | IntegerSchema - | BooleanSchema - | FileSchema - | ArraySchema - | ObjectSchema - | BaseReference; + | StringSchema + | NumberSchema + | IntegerSchema + | BooleanSchema + | FileSchema + | ArraySchema + | ObjectSchema + | BaseReference; /** * ----- diff --git a/2.0/security.ts b/2.0/security.ts index d96cc56..4109f00 100644 --- a/2.0/security.ts +++ b/2.0/security.ts @@ -38,105 +38,105 @@ import type { Extension } from "./extensions"; * ``` */ export interface SecurityScheme extends Extension { - /** - * The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2". - * This field is required. - * - * - **basic**: Basic HTTP authentication - * - **apiKey**: API key authentication (header or query parameter) - * - **oauth2**: OAuth 2.0 authentication - * - * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - type} - * - * @example "apiKey" - * @example "oauth2" - * @example "basic" - */ - type: "basic" | "apiKey" | "oauth2"; + /** + * The type of the security scheme. Valid values are "basic", "apiKey" or "oauth2". + * This field is required. + * + * - **basic**: Basic HTTP authentication + * - **apiKey**: API key authentication (header or query parameter) + * - **oauth2**: OAuth 2.0 authentication + * + * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - type} + * + * @example "apiKey" + * @example "oauth2" + * @example "basic" + */ + type: "basic" | "apiKey" | "oauth2"; - /** - * A short description for security scheme. GFM syntax can be used for rich text representation. - * - * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - description} - * - * @example "API key for authentication" - * @example "OAuth 2.0 with authorization code flow" - */ - description?: string; + /** + * A short description for security scheme. GFM syntax can be used for rich text representation. + * + * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - description} + * + * @example "API key for authentication" + * @example "OAuth 2.0 with authorization code flow" + */ + description?: string; - /** - * The name of the header or query parameter to be used. This field is required - * for apiKey type and applies to apiKey type only. - * - * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - name} - * - * @example "X-API-Key" - * @example "Authorization" - */ - name?: string; + /** + * The name of the header or query parameter to be used. This field is required + * for apiKey type and applies to apiKey type only. + * + * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - name} + * + * @example "X-API-Key" + * @example "Authorization" + */ + name?: string; - /** - * The location of the API key. This field is required for apiKey type and - * applies to apiKey type only. Valid values are "query" or "header". - * - * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - in} - * - * @example "header" - * @example "query" - */ - in?: "query" | "header"; + /** + * The location of the API key. This field is required for apiKey type and + * applies to apiKey type only. Valid values are "query" or "header". + * + * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - in} + * + * @example "header" + * @example "query" + */ + in?: "query" | "header"; - /** - * The flow used by the OAuth2 security scheme. This field is required for - * oauth2 type and applies to oauth2 type only. Valid values are "implicit", - * "password", "application" or "accessCode". - * - * - **implicit**: Implicit flow - * - **password**: Resource owner password credentials flow - * - **application**: Client credentials flow - * - **accessCode**: Authorization code flow - * - * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - flow} - * - * @example "accessCode" - * @example "implicit" - * @example "password" - */ - flow?: "implicit" | "password" | "application" | "accessCode"; + /** + * The flow used by the OAuth2 security scheme. This field is required for + * oauth2 type and applies to oauth2 type only. Valid values are "implicit", + * "password", "application" or "accessCode". + * + * - **implicit**: Implicit flow + * - **password**: Resource owner password credentials flow + * - **application**: Client credentials flow + * - **accessCode**: Authorization code flow + * + * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - flow} + * + * @example "accessCode" + * @example "implicit" + * @example "password" + */ + flow?: "implicit" | "password" | "application" | "accessCode"; - /** - * The authorization URL to be used for this flow. This SHOULD be in the form of - * a URL. This field is required for oauth2 type and applies to oauth2 type only. - * - * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - authorizationUrl} - * - * @example "https://example.com/oauth/authorize" - * @example "https://api.example.com/oauth/authorize" - */ - authorizationUrl?: string; + /** + * The authorization URL to be used for this flow. This SHOULD be in the form of + * a URL. This field is required for oauth2 type and applies to oauth2 type only. + * + * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - authorizationUrl} + * + * @example "https://example.com/oauth/authorize" + * @example "https://api.example.com/oauth/authorize" + */ + authorizationUrl?: string; - /** - * The token URL to be used for this flow. This SHOULD be in the form of a URL. - * This field is required for oauth2 type and applies to oauth2 type only. - * - * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - tokenUrl} - * - * @example "https://example.com/oauth/token" - * @example "https://api.example.com/oauth/token" - */ - tokenUrl?: string; + /** + * The token URL to be used for this flow. This SHOULD be in the form of a URL. + * This field is required for oauth2 type and applies to oauth2 type only. + * + * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - tokenUrl} + * + * @example "https://example.com/oauth/token" + * @example "https://api.example.com/oauth/token" + */ + tokenUrl?: string; - /** - * The available scopes for the OAuth2 security scheme. The key is the scope name - * and the value is a short description of the scope. This field is required for - * oauth2 type and applies to oauth2 type only. - * - * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - scopes} - * - * @example { "read": "Read access to resources", "write": "Write access to resources" } - * @example { "admin": "Administrative access" } - */ - scopes?: Scopes; + /** + * The available scopes for the OAuth2 security scheme. The key is the scope name + * and the value is a short description of the scope. This field is required for + * oauth2 type and applies to oauth2 type only. + * + * @see {@link https://swagger.io/specification/v2/#security-scheme-object | Swagger 2.0 Specification - scopes} + * + * @example { "read": "Read access to resources", "write": "Write access to resources" } + * @example { "admin": "Administrative access" } + */ + scopes?: Scopes; } /** @@ -154,16 +154,16 @@ export interface SecurityScheme extends Extension { * ``` */ export interface Scopes { - /** - * Maps between a name of a scope to a short description of it (as the value of the property). - * The key is the scope name and the value is a short description of the scope. - * - * @see {@link https://swagger.io/specification/v2/#scopes-object | Swagger 2.0 Specification - scopes} - * - * @example { "read": "Read access to resources", "write": "Write access to resources" } - * @example { "admin": "Administrative access" } - */ - [scopeName: string]: string; + /** + * Maps between a name of a scope to a short description of it (as the value of the property). + * The key is the scope name and the value is a short description of the scope. + * + * @see {@link https://swagger.io/specification/v2/#scopes-object | Swagger 2.0 Specification - scopes} + * + * @example { "read": "Read access to resources", "write": "Write access to resources" } + * @example { "admin": "Administrative access" } + */ + [scopeName: string]: string; } /** @@ -192,17 +192,17 @@ export interface Scopes { * ``` */ export interface SecurityRequirement { - /** - * Each name must correspond to a security scheme which is declared in the Security Definitions. - * If the security scheme is of type "oauth2", then the value is a list of scope names - * required for the execution. For other security scheme types, the array MUST be empty. - * - * @see {@link https://swagger.io/specification/v2/#security-requirement-object | Swagger 2.0 Specification - security requirement} - * - * @example { "api_key": [] } - * @example { "oauth2": ["read", "write"] } - */ - [schemeName: string]: string[]; + /** + * Each name must correspond to a security scheme which is declared in the Security Definitions. + * If the security scheme is of type "oauth2", then the value is a list of scope names + * required for the execution. For other security scheme types, the array MUST be empty. + * + * @see {@link https://swagger.io/specification/v2/#security-requirement-object | Swagger 2.0 Specification - security requirement} + * + * @example { "api_key": [] } + * @example { "oauth2": ["read", "write"] } + */ + [schemeName: string]: string[]; } /** diff --git a/2.0/spec.ts b/2.0/spec.ts index 38dfb68..a74ebaf 100644 --- a/2.0/spec.ts +++ b/2.0/spec.ts @@ -3,11 +3,7 @@ import type { ExternalDocumentation } from "./externalDocs"; // Import all the major component types import type { Info } from "./info"; import type { Paths } from "./paths"; -import type { - Definitions, - ParametersDefinitions, - ResponsesDefinitions, -} from "./schema"; +import type { Definitions, ParametersDefinitions, ResponsesDefinitions } from "./schema"; import type { SecurityDefinitions, SecurityRequirement } from "./security"; import type { Tag } from "./tags"; @@ -65,172 +61,172 @@ import type { Tag } from "./tags"; * ``` */ export type Specification = { - /** - * Specifies the Swagger specification version being used. - * Must be "2.0" for this specification. - * - * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - swagger} - */ - swagger: "2.0"; + /** + * Specifies the Swagger specification version being used. + * Must be "2.0" for this specification. + * + * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - swagger} + */ + swagger: "2.0"; - /** - * Provides metadata about the API. The metadata can be used by the clients - * if needed, and can be presented in the Swagger-UI for convenience. - * - * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - info} - */ - info: Info; + /** + * Provides metadata about the API. The metadata can be used by the clients + * if needed, and can be presented in the Swagger-UI for convenience. + * + * @see {@link https://swagger.io/specification/v2/#info-object | Swagger 2.0 Specification - info} + */ + info: Info; - /** - * The host (name or IP) serving the API. This MUST be the host only and does - * not include the scheme nor sub-paths. It MAY include a port. If the host - * is not included, the host serving the documentation is to be used - * (including the port). The host does not support path templating. - * - * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - host} - * - * @example "api.example.com" - * @example "api.example.com:8080" - */ - host?: string; + /** + * The host (name or IP) serving the API. This MUST be the host only and does + * not include the scheme nor sub-paths. It MAY include a port. If the host + * is not included, the host serving the documentation is to be used + * (including the port). The host does not support path templating. + * + * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - host} + * + * @example "api.example.com" + * @example "api.example.com:8080" + */ + host?: string; - /** - * The base path on which the API is served, which is relative to the host. - * If it is not included, the API is served directly under the host. - * The value MUST start with a leading slash (/). The basePath does not - * support path templating. - * - * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - basePath} - * - * @example "/v1" - * @example "/api/v2" - */ - basePath?: string; + /** + * The base path on which the API is served, which is relative to the host. + * If it is not included, the API is served directly under the host. + * The value MUST start with a leading slash (/). The basePath does not + * support path templating. + * + * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - basePath} + * + * @example "/v1" + * @example "/api/v2" + */ + basePath?: string; - /** - * The transfer protocol of the API. Values MUST be from the list: - * "http", "https", "ws", "wss". If the schemes is not included, the default - * scheme to be used is the one used to access the specification. - * - * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - schemes} - * - * @example ["https", "http"] - * @example ["wss"] - */ - schemes?: Array<"http" | "https" | "ws" | "wss">; + /** + * The transfer protocol of the API. Values MUST be from the list: + * "http", "https", "ws", "wss". If the schemes is not included, the default + * scheme to be used is the one used to access the specification. + * + * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - schemes} + * + * @example ["https", "http"] + * @example ["wss"] + */ + schemes?: Array<"http" | "https" | "ws" | "wss">; - /** - * A list of MIME types the APIs can consume. This is global to all APIs - * but can be overridden on specific API calls. Value MUST be as described - * under Mime Types. - * - * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - consumes} - * - * @example ["application/json"] - * @example ["application/xml", "application/json"] - */ - consumes?: string[]; + /** + * A list of MIME types the APIs can consume. This is global to all APIs + * but can be overridden on specific API calls. Value MUST be as described + * under Mime Types. + * + * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - consumes} + * + * @example ["application/json"] + * @example ["application/xml", "application/json"] + */ + consumes?: string[]; - /** - * A list of MIME types the APIs can produce. This is global to all APIs - * but can be overridden on specific API calls. Value MUST be as described - * under Mime Types. - * - * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - produces} - * - * @example ["application/json"] - * @example ["application/xml", "application/json"] - */ - produces?: string[]; + /** + * A list of MIME types the APIs can produce. This is global to all APIs + * but can be overridden on specific API calls. Value MUST be as described + * under Mime Types. + * + * @see {@link https://swagger.io/specification/v2/#swagger-object | Swagger 2.0 Specification - produces} + * + * @example ["application/json"] + * @example ["application/xml", "application/json"] + */ + produces?: string[]; - /** - * The available paths and operations for the API. This is the root of the - * Path Item Object. It does not define a path or a basePath, they are defined - * in the Paths Object. A relative path to an individual endpoint. The field - * name MUST begin with a slash. The path is appended to the basePath in order - * to construct the full URL. Path templating is allowed. - * - * @see {@link https://swagger.io/specification/v2/#paths-object | Swagger 2.0 Specification - paths} - * - * @example { "/users": { get: { ... } } } - * @example { "/users/{id}": { get: { ... } } } - */ - paths: Paths; + /** + * The available paths and operations for the API. This is the root of the + * Path Item Object. It does not define a path or a basePath, they are defined + * in the Paths Object. A relative path to an individual endpoint. The field + * name MUST begin with a slash. The path is appended to the basePath in order + * to construct the full URL. Path templating is allowed. + * + * @see {@link https://swagger.io/specification/v2/#paths-object | Swagger 2.0 Specification - paths} + * + * @example { "/users": { get: { ... } } } + * @example { "/users/{id}": { get: { ... } } } + */ + paths: Paths; - /** - * An object to hold data types produced and consumed by operations. - * These data types can be primitives, arrays or models. - * - * @see {@link https://swagger.io/specification/v2/#definitions-object | Swagger 2.0 Specification - definitions} - * - * @example { "User": { type: "object", properties: { ... } } } - */ - definitions?: Definitions; + /** + * An object to hold data types produced and consumed by operations. + * These data types can be primitives, arrays or models. + * + * @see {@link https://swagger.io/specification/v2/#definitions-object | Swagger 2.0 Specification - definitions} + * + * @example { "User": { type: "object", properties: { ... } } } + */ + definitions?: Definitions; - /** - * An object to hold parameters that can be used across operations. - * This property does not define global parameters for all operations. - * - * @see {@link https://swagger.io/specification/v2/#parameters-definitions-object | Swagger 2.0 Specification - parameters} - * - * @example { "pageParam": { name: "page", in: "query", type: "integer" } } - */ - parameters?: ParametersDefinitions; + /** + * An object to hold parameters that can be used across operations. + * This property does not define global parameters for all operations. + * + * @see {@link https://swagger.io/specification/v2/#parameters-definitions-object | Swagger 2.0 Specification - parameters} + * + * @example { "pageParam": { name: "page", in: "query", type: "integer" } } + */ + parameters?: ParametersDefinitions; - /** - * An object to hold responses that can be used across operations. - * This property does not define global responses for all operations. - * - * @see {@link https://swagger.io/specification/v2/#responses-definitions-object | Swagger 2.0 Specification - responses} - * - * @example { "NotFound": { description: "Entity not found" } } - */ - responses?: ResponsesDefinitions; + /** + * An object to hold responses that can be used across operations. + * This property does not define global responses for all operations. + * + * @see {@link https://swagger.io/specification/v2/#responses-definitions-object | Swagger 2.0 Specification - responses} + * + * @example { "NotFound": { description: "Entity not found" } } + */ + responses?: ResponsesDefinitions; - /** - * Security scheme definitions that can be used by the operations. - * Supported schemes are basic authentication, an API key (either as a header - * or as a query parameter) and OAuth2's common flows (implicit, password, - * application and access code). - * - * @see {@link https://swagger.io/specification/v2/#security-definitions-object | Swagger 2.0 Specification - securityDefinitions} - * - * @example { "api_key": { type: "apiKey", in: "header", name: "X-API-Key" } } - */ - securityDefinitions?: SecurityDefinitions; + /** + * Security scheme definitions that can be used by the operations. + * Supported schemes are basic authentication, an API key (either as a header + * or as a query parameter) and OAuth2's common flows (implicit, password, + * application and access code). + * + * @see {@link https://swagger.io/specification/v2/#security-definitions-object | Swagger 2.0 Specification - securityDefinitions} + * + * @example { "api_key": { type: "apiKey", in: "header", name: "X-API-Key" } } + */ + securityDefinitions?: SecurityDefinitions; - /** - * A declaration of which security schemes are applied for the API as a whole. - * The list of values describes alternative security schemes that can be used - * (that is, there is a logical OR between the security requirements). - * Individual operations can override this definition. - * - * @see {@link https://swagger.io/specification/v2/#security-requirement-object | Swagger 2.0 Specification - security} - * - * @example [{ "api_key": [] }] - * @example [{ "oauth2": ["read", "write"] }] - */ - security?: SecurityRequirement[]; + /** + * A declaration of which security schemes are applied for the API as a whole. + * The list of values describes alternative security schemes that can be used + * (that is, there is a logical OR between the security requirements). + * Individual operations can override this definition. + * + * @see {@link https://swagger.io/specification/v2/#security-requirement-object | Swagger 2.0 Specification - security} + * + * @example [{ "api_key": [] }] + * @example [{ "oauth2": ["read", "write"] }] + */ + security?: SecurityRequirement[]; - /** - * 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. - * - * @see {@link https://swagger.io/specification/v2/#tag-object | Swagger 2.0 Specification - tags} - * - * @example [{ name: "users", description: "User management" }] - */ - tags?: Tag[]; + /** + * 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. + * + * @see {@link https://swagger.io/specification/v2/#tag-object | Swagger 2.0 Specification - tags} + * + * @example [{ name: "users", description: "User management" }] + */ + tags?: Tag[]; - /** - * Additional external documentation. - * - * @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - externalDocs} - * - * @example { description: "Find out more about our API", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation. + * + * @see {@link https://swagger.io/specification/v2/#external-documentation-object | Swagger 2.0 Specification - externalDocs} + * + * @example { description: "Find out more about our API", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; } & Extension; diff --git a/2.0/status.ts b/2.0/status.ts index 85371be..c601930 100644 --- a/2.0/status.ts +++ b/2.0/status.ts @@ -11,925 +11,925 @@ import type { Response } from "./paths"; * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html | RFC 9110: HTTP Semantics} */ export interface ResponsesMap { - //#region 1xx — Informational - - /** 100 Continue - * - * Indicates that the initial part of the request has been received and the client should continue with the request. - * - * The server has received the request headers and the client should proceed to send the request body. - * - * Used in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns. - * - * The server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue | RFC 9110 §15.2.1} - */ - "100"?: Response; - - /** 101 Switching Protocols - * - * Indicates that the server is switching protocols as requested by the client. - * - * The server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols. - * - * Primarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios. - * - * The connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols | RFC 9110 §15.2.2} - */ - "101"?: Response; - - /** 102 Processing - * - * Indicates that the server has received and is processing the request, but no response is available yet. - * - * The server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting. - * - * Primarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods. - * - * The request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2518 | RFC 2518 (WebDAV)} - */ - "102"?: Response; - - /** 103 Early Hints - * - * Provides early hints about the response that will be sent, allowing the client to start processing before the full response is ready. - * - * The server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early. - * - * Used for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance. - * - * The client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc8297 | RFC 8297} - */ - "103"?: Response; - - /** 104 Upload Resumption Supported — TEMPORARY - * - * Indicates that the server supports resumable uploads for the requested resource. - * - * The server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off. - * - * Used in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste. - * - * The client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions. - * - * @note Temporary registration; see IANA entry for current status/expiry. - * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05 | draft-ietf-httpbis-resumable-upload-05} - * @see {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | IANA registry} - */ - "104"?: Response; - - //#endregion - - //#region 2xx — Success - - /** 200 OK - * - * Indicates that the request has succeeded and the response contains the requested data. - * - * The request was processed successfully and the response body contains the requested resource or data. - * - * The most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return. - * - * The operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok | RFC 9110 §15.3.1} - */ - "200"?: Response; - - /** 201 Created - * - * Indicates that the request has succeeded and a new resource has been created as a result. - * - * The request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource. - * - * Used for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations. - * - * A new resource was successfully created and the response contains information about the created resource, typically including its ID and location. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created | RFC 9110 §15.3.2} - */ - "201"?: Response; - - /** 202 Accepted - * - * Indicates that the request has been accepted for processing, but the processing has not been completed. - * - * The request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed. - * - * Used for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone. - * - * The request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted | RFC 9110 §15.3.3} - */ - "202"?: Response; - - /** 203 Non-Authoritative Information - * - * Indicates that the request was successful, but the information returned is from a transformed or cached version of the original resource. - * - * The response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version. - * - * Used when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware. - * - * The request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-informat | RFC 9110 §15.3.4} - */ - "203"?: Response; - - /** 204 No Content - * - * Indicates that the request has succeeded but there is no content to return in the response body. - * - * The request was processed successfully but the response body is intentionally empty. The client should not expect any content. - * - * Used for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data. - * - * The operation completed successfully but no data is returned. The client should not attempt to parse a response body. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content | RFC 9110 §15.3.5} - */ - "204"?: Response; - - /** 205 Reset Content - * - * Indicates that the request has succeeded and the client should reset the document view that caused the request to be sent. - * - * The request was processed successfully and the client should clear any form data or reset the user interface state. - * - * Used in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations. - * - * The operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content | RFC 9110 §15.3.6} - */ - "205"?: Response; - - /** 206 Partial Content - * - * Indicates that the server is delivering only part of the resource due to a range request. - * - * The request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered. - * - * Used for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads. - * - * The response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content | RFC 9110 §15.3.7} - */ - "206"?: Response; - - /** 207 Multi-Status - * - * Indicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body. - * - * The response contains multiple status codes for different operations, typically in XML format with individual operation results. - * - * Used in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms. - * - * Multiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "207"?: Response; - - /** 208 Already Reported - * - * Indicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again. - * - * Used in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported. - * - * Used in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations. - * - * The information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} - */ - "208"?: Response; - - /** 226 IM Used - * - * Indicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. - * - * The response represents the result of applying instance manipulations (like delta encoding) to the current resource instance. - * - * Used in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission. - * - * The response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc3229 | RFC 3229} - */ - "226"?: Response; - - //#endregion - - //#region 3xx — Redirection - - /** 300 Multiple Choices - * - * Indicates that the request has multiple possible responses and the client should choose one. - * - * The server has multiple representations of the requested resource and the client must choose which one to use. - * - * Used when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics. - * - * The client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices | RFC 9110 §15.4.1} - */ - "300"?: Response; - - /** 301 Moved Permanently - * - * Indicates that the requested resource has been permanently moved to a new location. - * - * The resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header. - * - * Used when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches. - * - * The resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently | RFC 9110 §15.4.2} - */ - "301"?: Response; - - /** 302 Found - * - * Indicates that the requested resource has been temporarily moved to a different location. - * - * The resource is temporarily available at a different URL, but the original URL should continue to be used for future requests. - * - * Used for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid. - * - * The resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found | RFC 9110 §15.4.3} - */ - "302"?: Response; - - /** 303 See Other - * - * Indicates that the response to the request can be found at a different URL and should be retrieved using a GET request. - * - * The request was processed but the response is available at a different location, and the client should use GET to retrieve it. - * - * Used in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions. - * - * The client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other | RFC 9110 §15.4.4} - */ - "303"?: Response; - - /** 304 Not Modified - * - * Indicates that the resource has not been modified since the last request, so the cached version can be used. - * - * The resource has not changed since the last request, and the client can use its cached version. No response body is included. - * - * Used for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer. - * - * The resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified | RFC 9110 §15.4.5} - */ - "304"?: Response; - - /** 305 Use Proxy - * - * Indicates that the requested resource must be accessed through the proxy specified in the Location header. - * - * The client must use the specified proxy to access the resource. This response is rarely used in modern web applications. - * - * Used in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development. - * - * The client should use the specified proxy to access the resource. This is rarely encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy | RFC 9110 §15.4.6} - */ - "305"?: Response; - - /** 306 (Unused) - * - * This status code is reserved and not used in current HTTP specifications. - * - * This status code was previously used but is now reserved and should not be used in new implementations. - * - * Not used in modern web applications. This code is reserved and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-306-unused | RFC 9110 §15.4.7} - */ - "306"?: Response; - - /** 307 Temporary Redirect - * - * Indicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved. - * - * The resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location. - * - * Used for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated. - * - * The resource is temporarily at a different location and the client should repeat the same request method to the new URL. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect | RFC 9110 §15.4.8} - */ - "307"?: Response; - - /** 308 Permanent Redirect - * - * Indicates that the requested resource has been permanently moved to a different location, and the request method should be preserved. - * - * The resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method. - * - * Used for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations. - * - * The resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect | RFC 9110 §15.4.9} - */ - "308"?: Response; - - //#endregion - - //#region 4xx — Client Error - - /** 400 Bad Request - * - * Indicates that the server cannot process the request due to a client error. - * - * The request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process. - * - * Used for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios. - * - * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request | RFC 9110 §15.5.1} - */ - "400"?: Response; - - /** 401 Unauthorized - * - * Indicates that the request requires authentication and the client has not provided valid credentials. - * - * The request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient. - * - * Used when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows. - * - * The client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized | RFC 9110 §15.5.2} - */ - "401"?: Response; - - /** 402 Payment Required - * - * Indicates that the request requires payment before it can be processed. - * - * The request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems. - * - * Used in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services. - * - * The client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required | RFC 9110 §15.5.3} - */ - "402"?: Response; - - /** 403 Forbidden - * - * Indicates that the server understood the request but refuses to authorize it. - * - * The client is authenticated but does not have permission to access the requested resource or perform the requested action. - * - * Used when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios. - * - * The client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden | RFC 9110 §15.5.4} - */ - "403"?: Response; - - /** 404 Not Found - * - * Indicates that the requested resource could not be found on the server. - * - * The server cannot find the requested resource at the specified URL, or the resource does not exist. - * - * Used when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints. - * - * The requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found | RFC 9110 §15.5.5} - */ - "404"?: Response; - - /** 405 Method Not Allowed - * - * Indicates that the HTTP method used in the request is not allowed for the requested resource. - * - * The resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource. - * - * Used when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design. - * - * The HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed | RFC 9110 §15.5.6} - */ - "405"?: Response; - - /** 406 Not Acceptable - * - * Indicates that the server cannot produce a response matching the client's Accept headers. - * - * The server cannot generate a response in any of the formats requested by the client's Accept headers. - * - * Used when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches. - * - * The server cannot provide the requested content type. The client should check the Accept headers or request a different format. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable | RFC 9110 §15.5.7} - */ - "406"?: Response; - - /** 407 Proxy Authentication Required - * - * Indicates that the client must authenticate with the proxy server before the request can be processed. - * - * The proxy server requires authentication before it will forward the request to the destination server. - * - * Used in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies. - * - * The client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-req | RFC 9110 §15.5.8} - */ - "407"?: Response; - - /** 408 Request Timeout - * - * Indicates that the server timed out while waiting for the request from the client. - * - * The server did not receive a complete request within the time it was prepared to wait. - * - * Used when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests. - * - * The request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout | RFC 9110 §15.5.9} - */ - "408"?: Response; - - /** 409 Conflict - * - * Indicates that the request conflicts with the current state of the resource. - * - * The request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification. - * - * Used when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios. - * - * The request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | RFC 9110 §15.5.10} - */ - "409"?: Response; - - /** 410 Gone - * - * Indicates that the requested resource is no longer available and will not be available again. - * - * The resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found. - * - * Used when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios. - * - * The resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone | RFC 9110 §15.5.11} - */ - "410"?: Response; - - /** 411 Length Required - * - * Indicates that the server requires a Content-Length header in the request. - * - * The server cannot process the request without knowing the exact length of the request body. - * - * Used when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints. - * - * The client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required | RFC 9110 §15.5.12} - */ - "411"?: Response; - - /** 412 Precondition Failed - * - * Indicates that one or more preconditions in the request headers were not met. - * - * The server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since. - * - * Used in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios. - * - * The preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed | RFC 9110 §15.5.13} - */ - "412"?: Response; - - /** 413 Content Too Large - * - * Indicates that the request payload is too large for the server to process. - * - * The request body exceeds the server's maximum allowed size limit. - * - * Used when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting. - * - * The request payload is too large. The client should reduce the size of the request body or split it into smaller chunks. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large | RFC 9110 §15.5.14} - */ - "413"?: Response; - - /** 414 URI Too Long - * - * Indicates that the URI provided in the request is too long for the server to process. - * - * The URL exceeds the server's maximum allowed length limit. - * - * Used when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests. - * - * The URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long | RFC 9110 §15.5.15} - */ - "414"?: Response; - - /** 415 Unsupported Media Type - * - * Indicates that the server cannot process the request because the media type is not supported. - * - * The server cannot process the request body because the Content-Type is not supported or recognized. - * - * Used when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements. - * - * The content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type | RFC 9110 §15.5.16} - */ - "415"?: Response; - - /** 416 Range Not Satisfiable - * - * Indicates that the server cannot satisfy the range request specified in the Range header. - * - * The requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests. - * - * Used when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming. - * - * The range request is not satisfiable. The client should check the range specification or request the full resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable | RFC 9110 §15.5.17} - */ - "416"?: Response; - - /** 417 Expectation Failed - * - * Indicates that the server cannot meet the requirements of the Expect header. - * - * The server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation. - * - * Used when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations. - * - * The server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed | RFC 9110 §15.5.18} - */ - "417"?: Response; - - /** 418 (Unused) - * - * This status code is reserved and not used in current HTTP specifications. - * - * This status code is reserved and should not be used in new implementations. - * - * Not used in modern web applications. This code is reserved and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-418-unused | RFC 9110 §15.5.19} - */ - "418"?: Response; - - /** 421 Misdirected Request - * - * Indicates that the request was directed to a server that is not able to produce a response. - * - * The request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems. - * - * Used in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios. - * - * The request was sent to the wrong server. The client should retry the request, which may be routed to a different server. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request | RFC 9110 §15.5.20} - */ - "421"?: Response; - - /** 422 Unprocessable Content - * - * Indicates that the request is well-formed but contains semantic errors that prevent processing. - * - * The request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations. - * - * Used for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid. - * - * The request is well-formed but contains semantic errors. The client should fix the data and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content | RFC 9110 §15.5.21} - */ - "422"?: Response; - - /** 423 Locked - * - * Indicates that the requested resource is locked and cannot be modified. - * - * The resource is locked by another process or user and cannot be accessed or modified at this time. - * - * Used in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms. - * - * The resource is locked and cannot be accessed. The client should wait and retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "423"?: Response; - - /** 424 Failed Dependency - * - * Indicates that the request failed because it depended on another request that also failed. - * - * The request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations. - * - * Used in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios. - * - * The request failed due to a dependency failure. The client should check the dependencies and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "424"?: Response; - - /** 425 Too Early - * - * Indicates that the server is unwilling to process the request because it might be replayed. - * - * The server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns. - * - * Used in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols. - * - * The server is unwilling to process the request due to replay concerns. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc8470 | RFC 8470} - */ - "425"?: Response; - - /** 426 Upgrade Required - * - * Indicates that the server requires the client to upgrade to a different protocol. - * - * The server requires the client to use a different protocol version or upgrade to a newer version to access the resource. - * - * Used when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios. - * - * The client must upgrade to a different protocol version. The response should include upgrade information. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required | RFC 9110 §15.5.22} - */ - "426"?: Response; - - /** 428 Precondition Required - * - * Indicates that the server requires the request to include certain preconditions. - * - * The server requires the client to include specific preconditions in the request headers before it will process the request. - * - * Used when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios. - * - * The server requires specific preconditions. The client should include the required preconditions and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "428"?: Response; - - /** 429 Too Many Requests - * - * Indicates that the client has sent too many requests in a given time period and should slow down. - * - * The client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets. - * - * Used for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers. - * - * The client has exceeded the rate limit and should slow down. The client should wait before retrying the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "429"?: Response; - - /** 431 Request Header Fields Too Large - * - * Indicates that the server is unwilling to process the request because the header fields are too large. - * - * The request headers exceed the server's maximum allowed size limit. - * - * Used when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data. - * - * The request headers are too large. The client should reduce the size of the headers and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "431"?: Response; - - /** 451 Unavailable For Legal Reasons - * - * Indicates that the requested resource is unavailable due to legal reasons. - * - * The resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements. - * - * Used when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services. - * - * The resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc7725 | RFC 7725} - */ - "451"?: Response; - - //#endregion - - //#region 5xx — Server Error - - /** 500 Internal Server Error - * - * Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. - * - * The server encountered an internal error or exception that prevented it from processing the request successfully. - * - * Used for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems. - * - * The server encountered an internal error. The client should retry the request later, as this is typically a temporary issue. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error | RFC 9110 §15.6.1} - */ - "500"?: Response; - - /** 501 Not Implemented - * - * Indicates that the server does not support the functionality required to fulfill the request. - * - * The server does not recognize the request method or lacks the ability to fulfill the request. - * - * Used when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented. - * - * The server does not support the requested functionality. The client should check the API documentation for supported methods and features. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented | RFC 9110 §15.6.2} - */ - "501"?: Response; - - /** 502 Bad Gateway - * - * Indicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server. - * - * The server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access. - * - * Used in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems. - * - * The gateway received an invalid response from the upstream server. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway | RFC 9110 §15.6.3} - */ - "502"?: Response; - - /** 503 Service Unavailable - * - * Indicates that the server is temporarily unable to handle the request due to maintenance or overload. - * - * The server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints. - * - * Used during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows. - * - * The server is temporarily unavailable. The client should retry the request later, often with exponential backoff. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable | RFC 9110 §15.6.4} - */ - "503"?: Response; - - /** 504 Gateway Timeout - * - * Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server. - * - * The gateway or proxy server timed out while waiting for a response from the upstream server. - * - * Used in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times. - * - * The gateway timed out waiting for the upstream server. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout | RFC 9110 §15.6.5} - */ - "504"?: Response; - - /** 505 HTTP Version Not Supported - * - * Indicates that the server does not support the HTTP protocol version used in the request. - * - * The server does not support the HTTP protocol version specified in the request. - * - * Used when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios. - * - * The server does not support the HTTP version used in the request. The client should use a supported HTTP version. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-supporte | RFC 9110 §15.6.6} - */ - "505"?: Response; - - /** 506 Variant Also Negotiates - * - * Indicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation. - * - * The server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop. - * - * Used in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations. - * - * The server has a configuration error in content negotiation. The client should contact the server administrator. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2295 | RFC 2295} - */ - "506"?: Response; - - /** 507 Insufficient Storage - * - * Indicates that the server is unable to store the representation needed to complete the request. - * - * The server cannot store the representation required to complete the request, typically due to storage space limitations. - * - * Used in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms. - * - * The server cannot store the required representation. The client should check storage availability and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "507"?: Response; - - /** 508 Loop Detected - * - * Indicates that the server detected an infinite loop while processing the request. - * - * The server detected an infinite loop in the request processing, typically in WebDAV operations. - * - * Used in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios. - * - * The server detected an infinite loop. The client should check the request for circular references and retry. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} - */ - "508"?: Response; - - /** 510 Not Extended — OBSOLETED - * - * This status code is obsolete and should not be used in modern implementations. - * - * This status code was used for HTTP extensions but is now obsolete and should not be used. - * - * Not used in modern web applications. This code is obsolete and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2774 | RFC 2774 (Historic)} - * @see {@link https://datatracker.ietf.org/doc/status-change-http-experiments-to-historic/ | IETF: Status change of HTTP experiments to Historic} - */ - "510"?: Response; - - /** 511 Network Authentication Required - * - * Indicates that the client needs to authenticate to gain network access. - * - * The client must authenticate with the network before it can access the requested resource. - * - * Used in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication. - * - * The client needs to authenticate with the network. The client should follow the authentication process provided by the network. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "511"?: Response; - - //#endregion - - /** default — The default response for all codes not covered individually. */ - default?: Response; + //#region 1xx — Informational + + /** 100 Continue + * + * Indicates that the initial part of the request has been received and the client should continue with the request. + * + * The server has received the request headers and the client should proceed to send the request body. + * + * Used in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns. + * + * The server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue | RFC 9110 §15.2.1} + */ + "100"?: Response; + + /** 101 Switching Protocols + * + * Indicates that the server is switching protocols as requested by the client. + * + * The server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols. + * + * Primarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios. + * + * The connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols | RFC 9110 §15.2.2} + */ + "101"?: Response; + + /** 102 Processing + * + * Indicates that the server has received and is processing the request, but no response is available yet. + * + * The server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting. + * + * Primarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods. + * + * The request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2518 | RFC 2518 (WebDAV)} + */ + "102"?: Response; + + /** 103 Early Hints + * + * Provides early hints about the response that will be sent, allowing the client to start processing before the full response is ready. + * + * The server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early. + * + * Used for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance. + * + * The client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc8297 | RFC 8297} + */ + "103"?: Response; + + /** 104 Upload Resumption Supported — TEMPORARY + * + * Indicates that the server supports resumable uploads for the requested resource. + * + * The server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off. + * + * Used in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste. + * + * The client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions. + * + * @note Temporary registration; see IANA entry for current status/expiry. + * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05 | draft-ietf-httpbis-resumable-upload-05} + * @see {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | IANA registry} + */ + "104"?: Response; + + //#endregion + + //#region 2xx — Success + + /** 200 OK + * + * Indicates that the request has succeeded and the response contains the requested data. + * + * The request was processed successfully and the response body contains the requested resource or data. + * + * The most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return. + * + * The operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok | RFC 9110 §15.3.1} + */ + "200"?: Response; + + /** 201 Created + * + * Indicates that the request has succeeded and a new resource has been created as a result. + * + * The request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource. + * + * Used for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations. + * + * A new resource was successfully created and the response contains information about the created resource, typically including its ID and location. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created | RFC 9110 §15.3.2} + */ + "201"?: Response; + + /** 202 Accepted + * + * Indicates that the request has been accepted for processing, but the processing has not been completed. + * + * The request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed. + * + * Used for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone. + * + * The request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted | RFC 9110 §15.3.3} + */ + "202"?: Response; + + /** 203 Non-Authoritative Information + * + * Indicates that the request was successful, but the information returned is from a transformed or cached version of the original resource. + * + * The response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version. + * + * Used when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware. + * + * The request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-informat | RFC 9110 §15.3.4} + */ + "203"?: Response; + + /** 204 No Content + * + * Indicates that the request has succeeded but there is no content to return in the response body. + * + * The request was processed successfully but the response body is intentionally empty. The client should not expect any content. + * + * Used for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data. + * + * The operation completed successfully but no data is returned. The client should not attempt to parse a response body. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content | RFC 9110 §15.3.5} + */ + "204"?: Response; + + /** 205 Reset Content + * + * Indicates that the request has succeeded and the client should reset the document view that caused the request to be sent. + * + * The request was processed successfully and the client should clear any form data or reset the user interface state. + * + * Used in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations. + * + * The operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content | RFC 9110 §15.3.6} + */ + "205"?: Response; + + /** 206 Partial Content + * + * Indicates that the server is delivering only part of the resource due to a range request. + * + * The request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered. + * + * Used for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads. + * + * The response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content | RFC 9110 §15.3.7} + */ + "206"?: Response; + + /** 207 Multi-Status + * + * Indicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body. + * + * The response contains multiple status codes for different operations, typically in XML format with individual operation results. + * + * Used in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms. + * + * Multiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "207"?: Response; + + /** 208 Already Reported + * + * Indicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again. + * + * Used in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported. + * + * Used in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations. + * + * The information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} + */ + "208"?: Response; + + /** 226 IM Used + * + * Indicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. + * + * The response represents the result of applying instance manipulations (like delta encoding) to the current resource instance. + * + * Used in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission. + * + * The response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc3229 | RFC 3229} + */ + "226"?: Response; + + //#endregion + + //#region 3xx — Redirection + + /** 300 Multiple Choices + * + * Indicates that the request has multiple possible responses and the client should choose one. + * + * The server has multiple representations of the requested resource and the client must choose which one to use. + * + * Used when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics. + * + * The client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices | RFC 9110 §15.4.1} + */ + "300"?: Response; + + /** 301 Moved Permanently + * + * Indicates that the requested resource has been permanently moved to a new location. + * + * The resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header. + * + * Used when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches. + * + * The resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently | RFC 9110 §15.4.2} + */ + "301"?: Response; + + /** 302 Found + * + * Indicates that the requested resource has been temporarily moved to a different location. + * + * The resource is temporarily available at a different URL, but the original URL should continue to be used for future requests. + * + * Used for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid. + * + * The resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found | RFC 9110 §15.4.3} + */ + "302"?: Response; + + /** 303 See Other + * + * Indicates that the response to the request can be found at a different URL and should be retrieved using a GET request. + * + * The request was processed but the response is available at a different location, and the client should use GET to retrieve it. + * + * Used in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions. + * + * The client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other | RFC 9110 §15.4.4} + */ + "303"?: Response; + + /** 304 Not Modified + * + * Indicates that the resource has not been modified since the last request, so the cached version can be used. + * + * The resource has not changed since the last request, and the client can use its cached version. No response body is included. + * + * Used for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer. + * + * The resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified | RFC 9110 §15.4.5} + */ + "304"?: Response; + + /** 305 Use Proxy + * + * Indicates that the requested resource must be accessed through the proxy specified in the Location header. + * + * The client must use the specified proxy to access the resource. This response is rarely used in modern web applications. + * + * Used in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development. + * + * The client should use the specified proxy to access the resource. This is rarely encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy | RFC 9110 §15.4.6} + */ + "305"?: Response; + + /** 306 (Unused) + * + * This status code is reserved and not used in current HTTP specifications. + * + * This status code was previously used but is now reserved and should not be used in new implementations. + * + * Not used in modern web applications. This code is reserved and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-306-unused | RFC 9110 §15.4.7} + */ + "306"?: Response; + + /** 307 Temporary Redirect + * + * Indicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved. + * + * The resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location. + * + * Used for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated. + * + * The resource is temporarily at a different location and the client should repeat the same request method to the new URL. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect | RFC 9110 §15.4.8} + */ + "307"?: Response; + + /** 308 Permanent Redirect + * + * Indicates that the requested resource has been permanently moved to a different location, and the request method should be preserved. + * + * The resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method. + * + * Used for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations. + * + * The resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect | RFC 9110 §15.4.9} + */ + "308"?: Response; + + //#endregion + + //#region 4xx — Client Error + + /** 400 Bad Request + * + * Indicates that the server cannot process the request due to a client error. + * + * The request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process. + * + * Used for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios. + * + * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request | RFC 9110 §15.5.1} + */ + "400"?: Response; + + /** 401 Unauthorized + * + * Indicates that the request requires authentication and the client has not provided valid credentials. + * + * The request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient. + * + * Used when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows. + * + * The client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized | RFC 9110 §15.5.2} + */ + "401"?: Response; + + /** 402 Payment Required + * + * Indicates that the request requires payment before it can be processed. + * + * The request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems. + * + * Used in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services. + * + * The client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required | RFC 9110 §15.5.3} + */ + "402"?: Response; + + /** 403 Forbidden + * + * Indicates that the server understood the request but refuses to authorize it. + * + * The client is authenticated but does not have permission to access the requested resource or perform the requested action. + * + * Used when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios. + * + * The client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden | RFC 9110 §15.5.4} + */ + "403"?: Response; + + /** 404 Not Found + * + * Indicates that the requested resource could not be found on the server. + * + * The server cannot find the requested resource at the specified URL, or the resource does not exist. + * + * Used when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints. + * + * The requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found | RFC 9110 §15.5.5} + */ + "404"?: Response; + + /** 405 Method Not Allowed + * + * Indicates that the HTTP method used in the request is not allowed for the requested resource. + * + * The resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource. + * + * Used when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design. + * + * The HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed | RFC 9110 §15.5.6} + */ + "405"?: Response; + + /** 406 Not Acceptable + * + * Indicates that the server cannot produce a response matching the client's Accept headers. + * + * The server cannot generate a response in any of the formats requested by the client's Accept headers. + * + * Used when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches. + * + * The server cannot provide the requested content type. The client should check the Accept headers or request a different format. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable | RFC 9110 §15.5.7} + */ + "406"?: Response; + + /** 407 Proxy Authentication Required + * + * Indicates that the client must authenticate with the proxy server before the request can be processed. + * + * The proxy server requires authentication before it will forward the request to the destination server. + * + * Used in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies. + * + * The client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-req | RFC 9110 §15.5.8} + */ + "407"?: Response; + + /** 408 Request Timeout + * + * Indicates that the server timed out while waiting for the request from the client. + * + * The server did not receive a complete request within the time it was prepared to wait. + * + * Used when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests. + * + * The request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout | RFC 9110 §15.5.9} + */ + "408"?: Response; + + /** 409 Conflict + * + * Indicates that the request conflicts with the current state of the resource. + * + * The request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification. + * + * Used when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios. + * + * The request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | RFC 9110 §15.5.10} + */ + "409"?: Response; + + /** 410 Gone + * + * Indicates that the requested resource is no longer available and will not be available again. + * + * The resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found. + * + * Used when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios. + * + * The resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone | RFC 9110 §15.5.11} + */ + "410"?: Response; + + /** 411 Length Required + * + * Indicates that the server requires a Content-Length header in the request. + * + * The server cannot process the request without knowing the exact length of the request body. + * + * Used when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints. + * + * The client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required | RFC 9110 §15.5.12} + */ + "411"?: Response; + + /** 412 Precondition Failed + * + * Indicates that one or more preconditions in the request headers were not met. + * + * The server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since. + * + * Used in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios. + * + * The preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed | RFC 9110 §15.5.13} + */ + "412"?: Response; + + /** 413 Content Too Large + * + * Indicates that the request payload is too large for the server to process. + * + * The request body exceeds the server's maximum allowed size limit. + * + * Used when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting. + * + * The request payload is too large. The client should reduce the size of the request body or split it into smaller chunks. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large | RFC 9110 §15.5.14} + */ + "413"?: Response; + + /** 414 URI Too Long + * + * Indicates that the URI provided in the request is too long for the server to process. + * + * The URL exceeds the server's maximum allowed length limit. + * + * Used when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests. + * + * The URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long | RFC 9110 §15.5.15} + */ + "414"?: Response; + + /** 415 Unsupported Media Type + * + * Indicates that the server cannot process the request because the media type is not supported. + * + * The server cannot process the request body because the Content-Type is not supported or recognized. + * + * Used when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements. + * + * The content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type | RFC 9110 §15.5.16} + */ + "415"?: Response; + + /** 416 Range Not Satisfiable + * + * Indicates that the server cannot satisfy the range request specified in the Range header. + * + * The requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests. + * + * Used when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming. + * + * The range request is not satisfiable. The client should check the range specification or request the full resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable | RFC 9110 §15.5.17} + */ + "416"?: Response; + + /** 417 Expectation Failed + * + * Indicates that the server cannot meet the requirements of the Expect header. + * + * The server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation. + * + * Used when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations. + * + * The server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed | RFC 9110 §15.5.18} + */ + "417"?: Response; + + /** 418 (Unused) + * + * This status code is reserved and not used in current HTTP specifications. + * + * This status code is reserved and should not be used in new implementations. + * + * Not used in modern web applications. This code is reserved and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-418-unused | RFC 9110 §15.5.19} + */ + "418"?: Response; + + /** 421 Misdirected Request + * + * Indicates that the request was directed to a server that is not able to produce a response. + * + * The request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems. + * + * Used in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios. + * + * The request was sent to the wrong server. The client should retry the request, which may be routed to a different server. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request | RFC 9110 §15.5.20} + */ + "421"?: Response; + + /** 422 Unprocessable Content + * + * Indicates that the request is well-formed but contains semantic errors that prevent processing. + * + * The request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations. + * + * Used for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid. + * + * The request is well-formed but contains semantic errors. The client should fix the data and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content | RFC 9110 §15.5.21} + */ + "422"?: Response; + + /** 423 Locked + * + * Indicates that the requested resource is locked and cannot be modified. + * + * The resource is locked by another process or user and cannot be accessed or modified at this time. + * + * Used in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms. + * + * The resource is locked and cannot be accessed. The client should wait and retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "423"?: Response; + + /** 424 Failed Dependency + * + * Indicates that the request failed because it depended on another request that also failed. + * + * The request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations. + * + * Used in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios. + * + * The request failed due to a dependency failure. The client should check the dependencies and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "424"?: Response; + + /** 425 Too Early + * + * Indicates that the server is unwilling to process the request because it might be replayed. + * + * The server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns. + * + * Used in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols. + * + * The server is unwilling to process the request due to replay concerns. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc8470 | RFC 8470} + */ + "425"?: Response; + + /** 426 Upgrade Required + * + * Indicates that the server requires the client to upgrade to a different protocol. + * + * The server requires the client to use a different protocol version or upgrade to a newer version to access the resource. + * + * Used when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios. + * + * The client must upgrade to a different protocol version. The response should include upgrade information. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required | RFC 9110 §15.5.22} + */ + "426"?: Response; + + /** 428 Precondition Required + * + * Indicates that the server requires the request to include certain preconditions. + * + * The server requires the client to include specific preconditions in the request headers before it will process the request. + * + * Used when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios. + * + * The server requires specific preconditions. The client should include the required preconditions and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "428"?: Response; + + /** 429 Too Many Requests + * + * Indicates that the client has sent too many requests in a given time period and should slow down. + * + * The client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets. + * + * Used for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers. + * + * The client has exceeded the rate limit and should slow down. The client should wait before retrying the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "429"?: Response; + + /** 431 Request Header Fields Too Large + * + * Indicates that the server is unwilling to process the request because the header fields are too large. + * + * The request headers exceed the server's maximum allowed size limit. + * + * Used when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data. + * + * The request headers are too large. The client should reduce the size of the headers and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "431"?: Response; + + /** 451 Unavailable For Legal Reasons + * + * Indicates that the requested resource is unavailable due to legal reasons. + * + * The resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements. + * + * Used when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services. + * + * The resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc7725 | RFC 7725} + */ + "451"?: Response; + + //#endregion + + //#region 5xx — Server Error + + /** 500 Internal Server Error + * + * Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. + * + * The server encountered an internal error or exception that prevented it from processing the request successfully. + * + * Used for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems. + * + * The server encountered an internal error. The client should retry the request later, as this is typically a temporary issue. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error | RFC 9110 §15.6.1} + */ + "500"?: Response; + + /** 501 Not Implemented + * + * Indicates that the server does not support the functionality required to fulfill the request. + * + * The server does not recognize the request method or lacks the ability to fulfill the request. + * + * Used when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented. + * + * The server does not support the requested functionality. The client should check the API documentation for supported methods and features. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented | RFC 9110 §15.6.2} + */ + "501"?: Response; + + /** 502 Bad Gateway + * + * Indicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server. + * + * The server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access. + * + * Used in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems. + * + * The gateway received an invalid response from the upstream server. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway | RFC 9110 §15.6.3} + */ + "502"?: Response; + + /** 503 Service Unavailable + * + * Indicates that the server is temporarily unable to handle the request due to maintenance or overload. + * + * The server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints. + * + * Used during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows. + * + * The server is temporarily unavailable. The client should retry the request later, often with exponential backoff. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable | RFC 9110 §15.6.4} + */ + "503"?: Response; + + /** 504 Gateway Timeout + * + * Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server. + * + * The gateway or proxy server timed out while waiting for a response from the upstream server. + * + * Used in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times. + * + * The gateway timed out waiting for the upstream server. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout | RFC 9110 §15.6.5} + */ + "504"?: Response; + + /** 505 HTTP Version Not Supported + * + * Indicates that the server does not support the HTTP protocol version used in the request. + * + * The server does not support the HTTP protocol version specified in the request. + * + * Used when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios. + * + * The server does not support the HTTP version used in the request. The client should use a supported HTTP version. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-supporte | RFC 9110 §15.6.6} + */ + "505"?: Response; + + /** 506 Variant Also Negotiates + * + * Indicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation. + * + * The server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop. + * + * Used in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations. + * + * The server has a configuration error in content negotiation. The client should contact the server administrator. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2295 | RFC 2295} + */ + "506"?: Response; + + /** 507 Insufficient Storage + * + * Indicates that the server is unable to store the representation needed to complete the request. + * + * The server cannot store the representation required to complete the request, typically due to storage space limitations. + * + * Used in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms. + * + * The server cannot store the required representation. The client should check storage availability and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "507"?: Response; + + /** 508 Loop Detected + * + * Indicates that the server detected an infinite loop while processing the request. + * + * The server detected an infinite loop in the request processing, typically in WebDAV operations. + * + * Used in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios. + * + * The server detected an infinite loop. The client should check the request for circular references and retry. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} + */ + "508"?: Response; + + /** 510 Not Extended — OBSOLETED + * + * This status code is obsolete and should not be used in modern implementations. + * + * This status code was used for HTTP extensions but is now obsolete and should not be used. + * + * Not used in modern web applications. This code is obsolete and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2774 | RFC 2774 (Historic)} + * @see {@link https://datatracker.ietf.org/doc/status-change-http-experiments-to-historic/ | IETF: Status change of HTTP experiments to Historic} + */ + "510"?: Response; + + /** 511 Network Authentication Required + * + * Indicates that the client needs to authenticate to gain network access. + * + * The client must authenticate with the network before it can access the requested resource. + * + * Used in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication. + * + * The client needs to authenticate with the network. The client should follow the authentication process provided by the network. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "511"?: Response; + + //#endregion + + /** default — The default response for all codes not covered individually. */ + default?: Response; } diff --git a/2.0/tags.ts b/2.0/tags.ts index 576238f..c7e4ddf 100644 --- a/2.0/tags.ts +++ b/2.0/tags.ts @@ -88,46 +88,46 @@ import type { ExternalDocumentation } from "./externalDocs"; * ``` */ export interface Tag extends Extension { - /** - * The name of the tag. This field is required and MUST be unique. - * - * The tag name is used to reference this tag in Operation objects and - * must be unique within the entire specification. It should be descriptive - * and follow a consistent naming convention. - * - * @see {@link https://swagger.io/specification/v2/#tag-object | Swagger 2.0 Specification - name} - * - * @example "users" - * @example "pets" - * @example "authentication" - * @example "reports" - */ - name: string; + /** + * The name of the tag. This field is required and MUST be unique. + * + * The tag name is used to reference this tag in Operation objects and + * must be unique within the entire specification. It should be descriptive + * and follow a consistent naming convention. + * + * @see {@link https://swagger.io/specification/v2/#tag-object | Swagger 2.0 Specification - name} + * + * @example "users" + * @example "pets" + * @example "authentication" + * @example "reports" + */ + name: string; - /** - * A short description for the tag. GFM syntax can be used for rich text representation. - * - * This description provides context about what operations belong to this tag - * and helps developers understand the purpose and scope of the tag. - * - * @see {@link https://swagger.io/specification/v2/#tag-object | Swagger 2.0 Specification - description} - * - * @example "User management operations" - * @example "Pet store operations including CRUD operations for pets" - * @example "Authentication and authorization operations" - */ - description?: string; + /** + * A short description for the tag. GFM syntax can be used for rich text representation. + * + * This description provides context about what operations belong to this tag + * and helps developers understand the purpose and scope of the tag. + * + * @see {@link https://swagger.io/specification/v2/#tag-object | Swagger 2.0 Specification - description} + * + * @example "User management operations" + * @example "Pet store operations including CRUD operations for pets" + * @example "Authentication and authorization operations" + */ + description?: string; - /** - * Additional external documentation for this tag. - * - * This allows for more detailed documentation about the tag and its - * associated operations to be provided via external resources. - * - * @see {@link https://swagger.io/specification/v2/#tag-object | Swagger 2.0 Specification - externalDocs} - * - * @example { description: "Find out more about user management", url: "https://example.com/docs/users" } - * @example { description: "Pet management API documentation", url: "https://petstore.example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for this tag. + * + * This allows for more detailed documentation about the tag and its + * associated operations to be provided via external resources. + * + * @see {@link https://swagger.io/specification/v2/#tag-object | Swagger 2.0 Specification - externalDocs} + * + * @example { description: "Find out more about user management", url: "https://example.com/docs/users" } + * @example { description: "Pet management API documentation", url: "https://petstore.example.com/docs" } + */ + externalDocs?: ExternalDocumentation; } diff --git a/2.0/xml.ts b/2.0/xml.ts index c8fa660..05243bd 100644 --- a/2.0/xml.ts +++ b/2.0/xml.ts @@ -88,55 +88,55 @@ import type { Extension } from "./extensions"; * ``` */ export interface XMLObject extends Extension { - /** - * Replaces the name of the element/attribute used for the described schema property. - * When defined within the Items Object, it will affect the name of the individual - * XML elements within the list. When defined alongside type being array (outside - * the items), it will affect the wrapping element and only if wrapped is true. - * - * @example "animal" - * @example "item" - * @example "person" - */ - name?: string; + /** + * Replaces the name of the element/attribute used for the described schema property. + * When defined within the Items Object, it will affect the name of the individual + * XML elements within the list. When defined alongside type being array (outside + * the items), it will affect the wrapping element and only if wrapped is true. + * + * @example "animal" + * @example "item" + * @example "person" + */ + name?: string; - /** - * The URL of the namespace definition. Value SHOULD be in the form of a URL. - * - * @example "http://example.com/schema/sample" - * @example "http://www.w3.org/2001/XMLSchema" - * @example "http://swagger.io/schema/sample" - */ - namespace?: string; + /** + * The URL of the namespace definition. Value SHOULD be in the form of a URL. + * + * @example "http://example.com/schema/sample" + * @example "http://www.w3.org/2001/XMLSchema" + * @example "http://swagger.io/schema/sample" + */ + namespace?: string; - /** - * The prefix to be used for the name. - * - * @example "sample" - * @example "xs" - * @example "ex" - */ - prefix?: string; + /** + * The prefix to be used for the name. + * + * @example "sample" + * @example "xs" + * @example "ex" + */ + prefix?: string; - /** - * Declares whether the property definition translates to an attribute instead of an element. - * Default value is false. - * - * @default false - * @example true - * @example false - */ - attribute?: boolean; + /** + * Declares whether the property definition translates to an attribute instead of an element. + * Default value is false. + * + * @default false + * @example true + * @example false + */ + attribute?: boolean; - /** - * MAY be used only for an array definition. Signifies whether the array is wrapped - * (for example, ) or unwrapped (). - * Default value is false. The definition takes effect only when defined alongside - * type being array (outside the items). - * - * @default false - * @example true - * @example false - */ - wrapped?: boolean; + /** + * MAY be used only for an array definition. Signifies whether the array is wrapped + * (for example, ) or unwrapped (). + * Default value is false. The definition takes effect only when defined alongside + * type being array (outside the items). + * + * @default false + * @example true + * @example false + */ + wrapped?: boolean; } diff --git a/3.0/3.0.0.md b/3.0/3.0.0.md index 8424825..123bd01 100644 --- a/3.0/3.0.0.md +++ b/3.0/3.0.0.md @@ -13,71 +13,75 @@ The OpenAPI Specification (OAS) defines a standard, language-agnostic interface An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. ## Table of Contents + - [Definitions](#definitions) - - [OpenAPI Document](#openapi-document) - - [Path Templating](#path-templating) - - [Media Types](#media-types) - - [HTTP Status Codes](#http-status-codes) + - [OpenAPI Document](#openapi-document) + - [Path Templating](#path-templating) + - [Media Types](#media-types) + - [HTTP Status Codes](#http-status-codes) - [Specification](#specification) - - [Versions](#versions) - - [Format](#format) - - [Document Structure](#document-structure) - - [Data Types](#data-types) - - [Rich Text Formatting](#rich-text-formatting) - - [Relative References In URLs](#relative-references-in-urls) - - [Schema](#schema) - - [OpenAPI Object](#openapi-object) - - [Info Object](#info-object) - - [Contact Object](#contact-object) - - [License Object](#license-object) - - [Server Object](#server-object) - - [Server Variable Object](#server-variable-object) - - [Components Object](#components-object) - - [Paths Object](#paths-object) - - [Path Item Object](#path-item-object) - - [Operation Object](#operation-object) - - [External Documentation Object](#external-documentation-object) - - [Parameter Object](#parameter-object) - - [Request Body Object](#request-body-object) - - [Media Type Object](#media-type-object) - - [Encoding Object](#encoding-object) - - [Responses Object](#responses-object) - - [Response Object](#response-object) - - [Callback Object](#callback-object) - - [Example Object](#example-object) - - [Link Object](#link-object) - - [Header Object](#header-object) - - [Tag Object](#tag-object) - - [Reference Object](#reference-object) - - [Schema Object](#schema-object) - - [Discriminator Object](#discriminator-object) - - [XML Object](#xml-object) - - [Security Scheme Object](#security-scheme-object) - - [OAuth Flows Object](#oauth-flows-object) - - [OAuth Flow Object](#oauth-flow-object) - - [Security Requirement Object](#security-requirement-object) - - [Specification Extensions](#specification-extensions) - - [Security Filtering](#security-filtering) + - [Versions](#versions) + - [Format](#format) + - [Document Structure](#document-structure) + - [Data Types](#data-types) + - [Rich Text Formatting](#rich-text-formatting) + - [Relative References In URLs](#relative-references-in-urls) + - [Schema](#schema) + - [OpenAPI Object](#openapi-object) + - [Info Object](#info-object) + - [Contact Object](#contact-object) + - [License Object](#license-object) + - [Server Object](#server-object) + - [Server Variable Object](#server-variable-object) + - [Components Object](#components-object) + - [Paths Object](#paths-object) + - [Path Item Object](#path-item-object) + - [Operation Object](#operation-object) + - [External Documentation Object](#external-documentation-object) + - [Parameter Object](#parameter-object) + - [Request Body Object](#request-body-object) + - [Media Type Object](#media-type-object) + - [Encoding Object](#encoding-object) + - [Responses Object](#responses-object) + - [Response Object](#response-object) + - [Callback Object](#callback-object) + - [Example Object](#example-object) + - [Link Object](#link-object) + - [Header Object](#header-object) + - [Tag Object](#tag-object) + - [Reference Object](#reference-object) + - [Schema Object](#schema-object) + - [Discriminator Object](#discriminator-object) + - [XML Object](#xml-object) + - [Security Scheme Object](#security-scheme-object) + - [OAuth Flows Object](#oauth-flows-object) + - [OAuth Flow Object](#oauth-flow-object) + - [Security Requirement Object](#security-requirement-object) + - [Specification Extensions](#specification-extensions) + - [Security Filtering](#security-filtering) - [Appendix A: Revision History](#appendix-a-revision-history) - ## Definitions ##### OpenAPI Document + A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification. ##### Path Templating + Path templating refers to the usage of curly braces ({}) to mark a section of a URL path as replaceable using path parameters. ##### Media Types + Media type definitions are spread across several resources. The media type definitions SHOULD be in compliance with [RFC6838](http://tools.ietf.org/html/rfc6838). Some examples of possible media type definitions: + ``` text/plain; charset=utf-8 application/json @@ -90,7 +94,9 @@ Some examples of possible media type definitions: application/vnd.github.v3.diff application/vnd.github.v3.patch ``` + ##### HTTP Status Codes + The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are defined by [RFC7231](http://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). @@ -100,9 +106,9 @@ The available status codes are defined by [RFC7231](http://tools.ietf.org/html/r The OpenAPI Specification is versioned using [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html) (semver) and follows the semver specification. -The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, *`.patch`* versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. +The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, _`.patch`_ versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. -Subsequent minor version releases of the OpenAPI Specification (incrementing the `minor` version number) SHOULD NOT interfere with tooling developed to a lower minor version and same major version. Thus a hypothetical `3.1.0` specification SHOULD be usable with tooling designed for `3.0.0`. +Subsequent minor version releases of the OpenAPI Specification (incrementing the `minor` version number) SHOULD NOT interfere with tooling developed to a lower minor version and same major version. Thus a hypothetical `3.1.0` specification SHOULD be usable with tooling designed for `3.0.0`. An OpenAPI document compatible with OAS 3.\*.\* contains a required [`openapi`](#oasVersion) field which designates the semantic version of the OAS that it uses. (OAS 2.0 documents contain a top-level version field named [`swagger`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerObject) and value `"2.0"`.) @@ -114,9 +120,10 @@ For example, if a field has an array value, the JSON array representation will b ```json { - "field": [ 1, 2, 3 ] + "field": [1, 2, 3] } ``` + All field names in the specification are **case sensitive**. The schema exposes two types of fields: Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name. @@ -151,21 +158,22 @@ Types that are not accompanied by a `format` property follow the type definition The formats defined by the OAS are: -Common Name | [`type`](#data-types) | [`format`](#dataTypeFormat) | Comments ------------ | ------ | -------- | -------- -integer | `integer` | `int32` | signed 32 bits -long | `integer` | `int64` | signed 64 bits -float | `number` | `float` | | -double | `number` | `double` | | -string | `string` | | | -byte | `string` | `byte` | base64 encoded characters -binary | `string` | `binary` | any sequence of octets -boolean | `boolean` | | | -date | `string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -password | `string` | `password` | A hint to UIs to obscure input. +| Common Name | [`type`](#data-types) | [`format`](#dataTypeFormat) | Comments | +| ----------- | --------------------- | --------------------------- | ------------------------------------------------------------------------------------------------ | +| integer | `integer` | `int32` | signed 32 bits | +| long | `integer` | `int64` | signed 64 bits | +| float | `number` | `float` | | +| double | `number` | `double` | | +| string | `string` | | | +| byte | `string` | `byte` | base64 encoded characters | +| binary | `string` | `binary` | any sequence of octets | +| boolean | `boolean` | | | +| date | `string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| password | `string` | `password` | A hint to UIs to obscure input. | ### Rich Text Formatting + Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting. Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by [CommonMark 0.27](http://spec.commonmark.org/0.27/). Tooling MAY choose to ignore some CommonMark features to address security concerns. @@ -186,16 +194,16 @@ This is the root document object of the [OpenAPI document](#openapi-document). ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](http://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string. -info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. -servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. -paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. -components | [Components Object](#components-object) | An element to hold various schemas for the specification. -security | [[Security Requirement Object](#security-requirement-object)] | 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. -tags | [[Tag Object](#tag-object)] | 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](#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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](http://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API [`info.version`](#infoVersion) string. | +| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. | +| paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. | +| components | [Components Object](#components-object) | An element to hold various schemas for the specification. | +| security | [[Security Requirement Object](#security-requirement-object)] | 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. | +| tags | [[Tag Object](#tag-object)] | 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -206,15 +214,14 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -title | `string` | **REQUIRED**. The title of the application. -description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. -contact | [Contact Object](#contact-object) | The contact information for the exposed API. -license | [License Object](#license-object) | The license information for the exposed API. -version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). - +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **REQUIRED**. The title of the application. | +| description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -258,11 +265,11 @@ Contact information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | The identifying name of the contact person/organization. -url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. -email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. +| Field Name | Type | Description | +| -------------------------------- | :------: | ------------------------------------------------------------------------------------------------ | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | +| email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -288,10 +295,10 @@ License information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The license name used for the API. -url | `string` | A URL to the license used for the API. MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------ | :------: | ---------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The license name used for the API. | +| url | `string` | A URL to the license used for the API. MUST be in the format of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -315,11 +322,11 @@ An object representing a Server. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. -description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. | +| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -362,12 +369,12 @@ The following shows how multiple servers can be described, for example, at the O ```yaml servers: -- url: https://development.gigantic-server.com/v1 - description: Development server -- url: https://staging.gigantic-server.com/v1 - description: Staging server -- url: https://api.gigantic-server.com/v1 - description: Production server + - url: https://development.gigantic-server.com/v1 + description: Development server + - url: https://staging.gigantic-server.com/v1 + description: Staging server + - url: https://api.gigantic-server.com/v1 + description: Production server ``` The following shows how variables can be used for a server configuration: @@ -384,10 +391,7 @@ The following shows how variables can be used for a server configuration: "description": "this value is assigned by the service provider, in this example `gigantic-server.com`" }, "port": { - "enum": [ - "8443", - "443" - ], + "enum": ["8443", "443"], "default": "8443" }, "basePath": { @@ -401,35 +405,34 @@ The following shows how variables can be used for a server configuration: ```yaml servers: -- url: https://{username}.gigantic-server.com:{port}/{basePath} - description: The production API server - variables: - username: - # note! no enum here means it is an open value - default: demo - description: this value is assigned by the service provider, in this example `gigantic-server.com` - port: - enum: - - '8443' - - '443' - default: '8443' - basePath: - # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` - default: v2 + - url: https://{username}.gigantic-server.com:{port}/{basePath} + description: The production API server + variables: + username: + # note! no enum here means it is an open value + default: demo + description: this value is assigned by the service provider, in this example `gigantic-server.com` + port: + enum: + - "8443" + - "443" + default: "8443" + basePath: + # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` + default: v2 ``` - #### Server Variable Object An object representing a Server Variable for server URL template substitution. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. -default | `string` | **REQUIRED**. The default value to use for substitution, and to send, if an alternate value is _not_ supplied. Unlike the [Schema Object's](#schema-object) `default`, this value MUST be provided by the consumer. -description | `string` | An optional description for the server variable. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. +| Field Name | Type | Description | +| --------------------------------------------------- | :--------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. | +| default | `string` | **REQUIRED**. The default value to use for substitution, and to send, if an alternate value is _not_ supplied. Unlike the [Schema Object's](#schema-object) `default`, this value MUST be provided by the consumer. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -438,20 +441,19 @@ This object MAY be extended with [Specification Extensions](#specification-exten Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. - ##### Fixed Fields -Field Name | Type | Description ----|:---|--- - schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). - responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). - parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). - examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). - requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). - headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). - securitySchemes| Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). - links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). - callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). +| Field Name | Type | Description | +| -------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). | +| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | +| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | +| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | +| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | +| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -605,7 +607,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GeneralError' + $ref: "#/components/schemas/GeneralError" securitySchemes: api_key: type: apiKey @@ -621,17 +623,16 @@ components: read:pets: read your pets ``` - #### Paths Object Holds the relative paths to the individual endpoints and their operations. -The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#security-filtering). +The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#security-filtering). ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -/{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. +| Field Pattern | Type | Description | +| ------------------------------- | :-----------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -666,7 +667,7 @@ The following may lead to ambiguous resolution: "get": { "description": "Returns all pets from the system that the user has access to", "responses": { - "200": { + "200": { "description": "A list of pets.", "content": { "application/json": { @@ -690,14 +691,14 @@ The following may lead to ambiguous resolution: get: description: Returns all pets from the system that the user has access to responses: - '200': + "200": description: A list of pets. content: application/json: schema: type: array items: - $ref: '#/components/schemas/pet' + $ref: "#/components/schemas/pet" ``` #### Path Item Object @@ -708,22 +709,21 @@ The path itself is still exposed to the documentation viewer but they will not k ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is *undefined*. -summary| `string` | An optional, string summary, intended to apply to all operations in this path. -description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -get | [Operation Object](#operation-object) | A definition of a GET operation on this path. -put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. -post | [Operation Object](#operation-object) | A definition of a POST operation on this path. -delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. -options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. -head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. -patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. -trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. -servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). - +| Field Name | Type | Description | +| --------------------------------------------- | :------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is _undefined_. | +| summary | `string` | An optional, string summary, intended to apply to all operations in this path. | +| description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | +| servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -785,30 +785,30 @@ get: summary: Find pets by ID operationId: getPetsById responses: - '200': + "200": description: pet response content: - '*/*' : + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: - 'text/html': + "text/html": schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" parameters: -- name: id - in: path - description: ID of pet to use - required: true - schema: - type: array - style: simple - items: - type: string + - name: id + in: path + description: ID of pet to use + required: true + schema: + type: array + style: simple + items: + type: string ``` #### Operation Object @@ -817,20 +817,20 @@ Describes a single API operation on a path. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. -summary | `string` | A short summary of what the operation does. -description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. -operationId | `string` | 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. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). -requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. -responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. -callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#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. -deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. -security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. -servers | [[Server Object](#server-object)] | 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. +| Field Name | Type | Description | +| ------------------------------------------------ | :-----------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. | +| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | 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. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | +| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. | +| responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#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. | +| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. | +| servers | [[Server Object](#server-object)] | 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -838,9 +838,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "tags": [ - "pet" - ], + "tags": ["pet"], "summary": "Updates a pet in the store with form data", "operationId": "updatePetWithForm", "parameters": [ @@ -859,17 +857,17 @@ This object MAY be extended with [Specification Extensions](#specification-exten "application/x-www-form-urlencoded": { "schema": { "type": "object", - "properties": { - "name": { - "description": "Updated name of the pet", - "type": "string" - }, - "status": { - "description": "Updated status of the pet", - "type": "string" - } - }, - "required": ["status"] + "properties": { + "name": { + "description": "Updated name of the pet", + "type": "string" + }, + "status": { + "description": "Updated status of the pet", + "type": "string" + } + }, + "required": ["status"] } } } @@ -892,10 +890,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten }, "security": [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] } @@ -903,57 +898,56 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```yaml tags: -- pet + - pet summary: Updates a pet in the store with form data operationId: updatePetWithForm parameters: -- name: petId - in: path - description: ID of pet that needs to be updated - required: true - schema: - type: string + - name: petId + in: path + description: ID of pet that needs to be updated + required: true + schema: + type: string requestBody: content: - 'application/x-www-form-urlencoded': + "application/x-www-form-urlencoded": schema: - properties: + properties: name: description: Updated name of the pet type: string status: description: Updated status of the pet type: string - required: - - status + required: + - status responses: - '200': + "200": description: Pet updated. content: - 'application/json': {} - 'application/xml': {} - '405': + "application/json": {} + "application/xml": {} + "405": description: Invalid input content: - 'application/json': {} - 'application/xml': {} + "application/json": {} + "application/xml": {} security: -- petstore_auth: - - write:pets - - read:pets + - petstore_auth: + - write:pets + - read:pets ``` - #### External Documentation Object Allows referencing an external resource for extended documentation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -978,58 +972,58 @@ Describes a single operation parameter. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). ##### Parameter Locations -There are four possible parameter locations specified by the `in` field: -* path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. -* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. -* cookie - Used to pass a specific cookie value to the API. +There are four possible parameter locations specified by the `in` field: + +- path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +- header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. +- cookie - Used to pass a specific cookie value to the API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
-in | `string` | **REQUIRED**. The location of the parameter. Possible values are "query", "header", "path" or "cookie". -description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is "path", this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. - deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. - allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. + +| Field Name | Type | Description | +| ------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
| +| in | `string` | **REQUIRED**. The location of the parameter. Possible values are "query", "header", "path" or "cookie". | +| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is "path", this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | +| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. | +| allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. | The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a [`schema`](#parameterSchema) and [`style`](#parameterStyle) can describe the structure and syntax of the parameter. -Field Name | Type | Description ----|:---:|--- -style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. -explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. -schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. -example | Any | 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. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | 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. +| Field Name | Type | Description | +| -------------------------------------------------- | :----------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. | +| explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. | +| example | Any | 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. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | 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. | For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. A parameter MUST contain either a `schema` property, or a `content` property, but not both. When `example` or `examples` are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the parameter. - -Field Name | Type | Description ----|:---:|--- -content | Map[`string`, [Media Type Object](#media-type-object)] | 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. +| Field Name | Type | Description | +| -------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| content | Map[`string`, [Media Type Object](#media-type-object)] | 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. | ##### Style Values In order to support common ways of serializing simple parameters, a set of `style` values are defined. -`style` | [`type`](#data-types) | `in` | Comments ------------ | ------ | -------- | -------- -matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) -label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) -form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. -simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. -spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. -pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. -deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. - +| `style` | [`type`](#data-types) | `in` | Comments | +| -------------- | ------------------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. | ##### Style Examples @@ -1040,21 +1034,22 @@ Assume a parameter named `color` has one of the following values: array -> ["blue","black","brown"] object -> { "R": 100, "G": 200, "B": 150 } ``` + The following table shows examples of rendering differences for each value. -[`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` ------------ | ------ | -------- | -------- | --------|------- -matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 -matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 -label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 -label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 -form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 -form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 -simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 -simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 -spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 -pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200|G\|150 -deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 +| [`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` | +| -------------------------- | --------- | ------- | ----------- | ----------------------------------- | -------------------------------------- | ------ | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +| simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 | +| spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 | +| pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200 | G\|150 | +| deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1093,6 +1088,7 @@ style: simple ``` A path parameter of a string value: + ```json { "name": "username", @@ -1115,6 +1111,7 @@ schema: ``` An optional query parameter of a string value, allowing multiple values by repeating the query parameter: + ```json { "name": "id", @@ -1146,6 +1143,7 @@ explode: true ``` A free-form query parameter, allowing undefined parameters of a specific type: + ```json { "in": "query", @@ -1154,7 +1152,7 @@ A free-form query parameter, allowing undefined parameters of a specific type: "type": "object", "additionalProperties": { "type": "integer" - }, + } }, "style": "form" } @@ -1180,10 +1178,7 @@ A complex parameter using `content` to define serialization: "application/json": { "schema": { "type": "object", - "required": [ - "lat", - "long" - ], + "required": ["lat", "long"], "properties": { "lat": { "type": "number" @@ -1220,18 +1215,19 @@ content: Describes a single request body. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. +| Field Name | Type | Description | +| ------------------------------------------------ | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ##### Request Body Examples A request body with a referenced model definition. + ```json { "description": "user to add to the system", @@ -1241,36 +1237,36 @@ A request body with a referenced model definition. "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User Example", - "externalValue": "http://foo.bar/examples/user-example.json" - } + "user": { + "summary": "User Example", + "externalValue": "http://foo.bar/examples/user-example.json" } + } }, "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User example in XML", - "externalValue": "http://foo.bar/examples/user-example.xml" - } + "user": { + "summary": "User example in XML", + "externalValue": "http://foo.bar/examples/user-example.xml" } + } }, "text/plain": { "examples": { - "user" : { - "summary": "User example in Plain text", - "externalValue": "http://foo.bar/examples/user-example.txt" + "user": { + "summary": "User example in Plain text", + "externalValue": "http://foo.bar/examples/user-example.txt" } } }, "*/*": { "examples": { - "user" : { - "summary": "User example in other format", - "externalValue": "http://foo.bar/examples/user-example.whatever" + "user": { + "summary": "User example in other format", + "externalValue": "http://foo.bar/examples/user-example.whatever" } } } @@ -1281,33 +1277,34 @@ A request body with a referenced model definition. ```yaml description: user to add to the system content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example - externalValue: 'http://foo.bar/examples/user-example.json' - 'application/xml': + externalValue: "http://foo.bar/examples/user-example.json" + "application/xml": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example in XML - externalValue: 'http://foo.bar/examples/user-example.xml' - 'text/plain': + externalValue: "http://foo.bar/examples/user-example.xml" + "text/plain": examples: user: summary: User example in text plain format - externalValue: 'http://foo.bar/examples/user-example.txt' - '*/*': + externalValue: "http://foo.bar/examples/user-example.txt" + "*/*": examples: user: summary: User example in other format - externalValue: 'http://foo.bar/examples/user-example.whatever' + externalValue: "http://foo.bar/examples/user-example.whatever" ``` A body parameter that is an array of string values: + ```json { "description": "user to add to the system", @@ -1335,17 +1332,18 @@ content: type: string ``` - #### Media Type Object + Each Media Type Object provides schema and examples for the media type identified by its key. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the request body. -example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` object is mutually exclusive of the `examples` object. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. 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. -encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. + +| Field Name | Type | Description | +| ---------------------------------------- | :----------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the request body. | +| example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` object is mutually exclusive of the `examples` object. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. 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. | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1451,15 +1449,15 @@ In addition, specific media types MAY be specified: # multiple, specific media types may be specified: requestBody: content: - # a binary file of type png or jpeg - 'image/jpeg': + # a binary file of type png or jpeg + "image/jpeg": schema: type: string format: binary - 'image/png': + "image/png": schema: type: string - format: binary + format: binary ``` To upload multiple files, a `multipart` media type MUST be used: @@ -1476,7 +1474,6 @@ requestBody: items: type: string format: binary - ``` ##### Support for x-www-form-urlencoded Request Bodies @@ -1500,20 +1497,19 @@ requestBody: properties: {} ``` -In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. +In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. When passing complex objects in the `application/x-www-form-urlencoded` content type, the default serialization strategy of such properties is described in the [`Encoding Object`](#encoding-object)'s [`style`](#encodingStyle) property as `form`. ##### Special Considerations for `multipart` Content -It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. +It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. When passing in `multipart` types, boundaries MAY be used to separate sections of the content being transferred — thus, the following default `Content-Type`s are defined for `multipart`: -* If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` -* If the property is complex, or an array of complex values, the default Content-Type is `application/json` -* If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` - +- If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` +- If the property is complex, or an array of complex values, the default Content-Type is `application/json` +- If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` Examples: @@ -1544,23 +1540,24 @@ requestBody: # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example) type: array items: - type: '#/components/schemas/Address' + type: "#/components/schemas/Address" ``` -An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. +An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. #### Encoding Object A single encoding definition applied to a single schema property. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. -style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. + +| Field Name | Type | Description | +| ------------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. | +| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1619,15 +1616,16 @@ The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. + +| Field Name | Type | Description | +| -------------------------------------- | :--------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -[HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. The following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response range is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. +| Field Pattern | Type | Description | +| ------------------------------------------------------------------ | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. The following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response range is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1661,31 +1659,33 @@ A 200 response for a successful operation and a default response for others (imp ``` ```yaml -'200': +"200": description: a pet to be returned content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: Unexpected error content: application/json: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` #### Response Object + Describes a single response from an API Operation, including design-time, static `links` to operations based on the response. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. -content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* -links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). + +| Field Name | Type | Description | +| --------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/\* | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1716,7 +1716,7 @@ content: schema: type: array items: - $ref: '#/components/schemas/VeryComplexType' + $ref: "#/components/schemas/VeryComplexType" ``` Response with a string type: @@ -1731,7 +1731,6 @@ Response with a string type: } } } - } ``` @@ -1784,7 +1783,7 @@ content: text/plain: schema: type: string - example: 'whoa!' + example: "whoa!" headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period @@ -1819,9 +1818,10 @@ Each value in the map is a [Path Item Object](#path-item-object) that describes 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. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. + +| Field Pattern | Type | Description | +| --------------------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1855,17 +1855,16 @@ Location: http://example.org/subscription/1 The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. -Expression | Value ----|:--- -$url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning -$method | POST -$request.path.eventType | myevent -$request.query.queryUrl | http://clientdomain.com/stillrunning -$request.header.content-Type | application/json -$request.body#/failedUrl | http://clientdomain.com/stillrunning -$request.body#/successUrls/2 | http://clientdomain.com/medium -$response.header.Location | http://example.org/subscription/1 - +| Expression | Value | +| ---------------------------- | :--------------------------------------------------------------------------------- | +| $url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | http://clientdomain.com/stillrunning | +| $request.header.content-Type | application/json | +| $request.body#/failedUrl | http://clientdomain.com/stillrunning | +| $request.body#/successUrls/2 | http://clientdomain.com/medium | +| $response.header.Location | http://example.org/subscription/1 | ##### Callback Object Example @@ -1873,34 +1872,34 @@ The following example shows a callback to the URL specified by the `id` and `ema ```yaml myWebhook: - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + "http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}": post: requestBody: description: Callback payload content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: webhook successfully processed and no retries will be performed ``` - #### Example Object ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -summary | `string` | Short description for the example. -description | `string` | Long description for the example. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. -externalValue | `string` | A 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. + +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | Short description for the example. | +| description | `string` | Long description for the example. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | +| externalValue | `string` | A 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). In all cases, the example value is expected to be compatible with the type schema -of its associated value. Tooling implementations MAY choose to +of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible. ##### Example Object Example @@ -1915,56 +1914,54 @@ schemas: name: $ref: http://example.org/petapi-examples/openapi.json#/components/examples/name-example -# in a request body: + # in a request body: requestBody: content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" examples: foo: summary: A foo example - value: {"foo": "bar"} + value: { "foo": "bar" } bar: summary: A bar example - value: {"bar": "baz"} - 'application/xml': + value: { "bar": "baz" } + "application/xml": examples: xmlExample: summary: This is an example in XML - externalValue: 'http://example.org/examples/address-example.xml' - 'text/plain': + externalValue: "http://example.org/examples/address-example.xml" + "text/plain": examples: textExample: summary: This is a text example - externalValue: 'http://foo.bar/examples/address-example.txt' + externalValue: "http://foo.bar/examples/address-example.txt" - -# in a parameter + # in a parameter parameters: - - name: 'zipCode' - in: 'query' + - name: "zipCode" + in: "query" schema: - type: 'string' - format: 'zip-code' + type: "string" + format: "zip-code" examples: zip-example: - $ref: '#/components/examples/zip-example' + $ref: "#/components/examples/zip-example" -# in a response + # in a response responses: - '200': + "200": description: your car appointment has been booked content: application/json: schema: - $ref: '#/components/schemas/SuccessResponse' + $ref: "#/components/schemas/SuccessResponse" examples: confirmation-success: - $ref: '#/components/examples/confirmation-success' + $ref: "#/components/examples/confirmation-success" ``` - #### Link Object The `Link object` represents a possible design-time link for a response. @@ -1972,18 +1969,18 @@ The presence of a link does not guarantee the caller's ability to successfully i Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response. -For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. +For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -operationRef | `string` | A relative or absolute reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. -operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. -parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). -requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. -description | `string` | A description of the link. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -server | [Server Object](#server-object) | A server object to be used by the target operation. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| operationRef | `string` | A relative or absolute reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). | +| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#server-object) | A server object to be used by the target operation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2000,15 +1997,15 @@ Computing a link from a request operation where the `$request.path.id` is used t paths: /users/{id}: parameters: - - name: id - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: id + in: path + required: true + description: the user identifier, as userId + schema: + type: string get: responses: - '200': + "200": description: the user being returned content: application/json: @@ -2028,18 +2025,18 @@ paths: # the path item of the linked operation /users/{userid}/address: parameters: - - name: userid - in: path - required: true - description: the user identifier, as userId - schema: - type: string - # linked operation - get: - operationId: getUserAddress - responses: - '200': - description: the user's address + - name: userid + in: path + required: true + description: the user identifier, as userId + schema: + type: string + # linked operation + get: + operationId: getUserAddress + responses: + "200": + description: the user's address ``` When a runtime expression fails to evaluate, no parameter value is passed to the target operation. @@ -2059,7 +2056,6 @@ Clients follow all links at their discretion. Neither permissions, nor the capability to make a successful call to that link, is guaranteed solely by the existence of a relationship. - ##### OperationRef Examples As references to `operationId` MAY NOT be possible (the `operationId` is an optional @@ -2069,7 +2065,7 @@ value), references MAY also be made through a relative `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: '#/paths/~12.0~1repositories~1{username}/get' + operationRef: "#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2080,7 +2076,7 @@ or an absolute `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: 'https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get' + operationRef: "https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2088,7 +2084,6 @@ links: Note that in the use of `operationRef`, the _escaped forward-slash_ is necessary when using JSON references. - ##### Runtime Expressions Runtime expressions allow defining values based on information that will only be available within the HTTP message in an actual API call. @@ -2098,12 +2093,12 @@ The runtime expression is defined by the following [ABNF](https://tools.ietf.org ``` expression = ( "$url" | "$method" | "$statusCode" | "$request." source | "$response." source ) - source = ( header-reference | query-reference | path-reference | body-reference ) + source = ( header-reference | query-reference | path-reference | body-reference ) header-reference = "header." token - query-reference = "query." name + query-reference = "query." name path-reference = "path." name body-reference = "body" ["#" fragment] - fragment = a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901) + fragment = a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901) name = *( char ) char = as per RFC [7159](https://tools.ietf.org/html/rfc7159#section-7) token = as per RFC [7230](https://tools.ietf.org/html/rfc7230#section-3.2.6) @@ -2115,15 +2110,15 @@ The table below provides examples of runtime expressions and examples of their u ##### Examples -Source Location | example expression | notes ----|:---|:---| -HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. -Requested media type | `$request.header.accept` | -Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. -Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. -Request URL | `$url` | -Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. -Response header | `$response.header.Server` | Single header values only are available +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | Runtime expressions preserve the type of the referenced value. Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. @@ -2161,11 +2156,12 @@ Adds metadata to a single tag that is used by the [Operation Object](#operation- It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the tag. -description | `string` | A short description for the tag. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. + +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the tag. | +| description | `string` | A short description for the tag. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2173,8 +2169,8 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "name": "pet", - "description": "Pets operations" + "name": "pet", + "description": "Pets operations" } ``` @@ -2191,7 +2187,7 @@ explicit restriction that examples having a JSON format with object named either a string primitive or an object, similar to `additionalProperties`. In all cases, the payload is expected to be compatible with the type schema -for the associated value. Tooling implementations MAY choose to +for the associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if they are incompatible. @@ -2204,44 +2200,44 @@ schemas: example: $ref: http://foo.bar#/examples/name-example -# in a request body, note the plural `examples` + # in a request body, note the plural `examples` requestBody: content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" examples: foo: - value: {"foo": "bar"} + value: { "foo": "bar" } bar: - value: {"bar": "baz"} - 'application/xml': + value: { "bar": "baz" } + "application/xml": examples: xml: - externalValue: 'http://foo.bar/examples/address-example.xml' - 'text/plain': + externalValue: "http://foo.bar/examples/address-example.xml" + "text/plain": examples: text: - externalValue: 'http://foo.bar/examples/address-example.txt' - -# in a parameter - parameters: - - name: 'zipCode' - in: 'query' - schema: - type: 'string' - format: 'zip-code' - example: - $ref: 'http://foo.bar#/examples/zip-example' + externalValue: "http://foo.bar/examples/address-example.txt" -# in a response, note the singular `example`: + # in a parameter + parameters: + - name: "zipCode" + in: "query" + schema: + type: "string" + format: "zip-code" + example: + $ref: "http://foo.bar#/examples/zip-example" + + # in a response, note the singular `example`: responses: - '200': + "200": description: your car appointment has been booked content: application/json: schema: - $ref: '#/components/schemas/SuccessResponse' + $ref: "#/components/schemas/SuccessResponse" example: $ref: http://foo.bar#/examples/address-example.json ``` @@ -2255,9 +2251,10 @@ The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/ For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | **REQUIRED**. The reference string. + +| Field Name | Type | Description | +| ------------------------------- | :------: | ----------------------------------- | +| $ref | `string` | **REQUIRED**. The reference string. | This object cannot be extended with additional properties and any properties added SHALL be ignored. @@ -2265,15 +2262,16 @@ This object cannot be extended with additional properties and any properties add ```json { - "$ref": "#/components/schemas/Pet" + "$ref": "#/components/schemas/Pet" } ``` ```yaml -$ref: '#/components/schemas/Pet' +$ref: "#/components/schemas/Pet" ``` ##### Relative Schema Document Example + ```json { "$ref": "Pet.json" @@ -2285,6 +2283,7 @@ $ref: Pet.yaml ``` ##### Relative Documents With Embedded Schema Example + ```json { "$ref": "definitions.json#/Pet" @@ -2326,6 +2325,7 @@ The following properties are taken directly from the JSON Schema definition and - enum The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification. + - type - Value MUST be a string. Multiple types via an array are not supported. - allOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. - oneOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. @@ -2345,32 +2345,34 @@ Additional properties defined by the JSON Schema specification that are not ment Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation: ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`. -discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. -readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". 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`. -writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". 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`. -xml | [XML Object](#xml-object) | 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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. -example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. - deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. + +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`. | +| discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. | +| readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". 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`. | +| writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". 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`. | +| xml | [XML Object](#xml-object) | 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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. | +| deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ###### Composition and Inheritance (Polymorphism) The OpenAPI Specification allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition. -`allOf` takes an array of object definitions that are validated *independently* but together compose a single object. +`allOf` takes an array of object definitions that are validated _independently_ but together compose a single object. While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, the OpenAPI Specification adds the `discriminator` field. When used, the `discriminator` will be the name of the property that decides which schema definition validates the structure of the model. As such, the `discriminator` field MUST be a required field. There are are two ways to define the value of a discriminator for an inheriting instance. + - Use the schema name. - Override the schema name by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. -As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism. + As such, inline schema definitions, which do not have a given id, _cannot_ be used in polymorphism. ###### XML Modeling @@ -2398,9 +2400,7 @@ format: email ```json { "type": "object", - "required": [ - "name" - ], + "required": ["name"], "properties": { "name": { "type": "string" @@ -2420,12 +2420,12 @@ format: email ```yaml type: object required: -- name + - name properties: name: type: string address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" age: type: integer format: int32 @@ -2465,7 +2465,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/components/schemas/ComplexModel' + $ref: "#/components/schemas/ComplexModel" ``` ###### Model with Example @@ -2482,9 +2482,7 @@ additionalProperties: "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "example": { "name": "Puma", "id": 1 @@ -2501,7 +2499,7 @@ properties: name: type: string required: -- name + - name example: name: Puma id: 1 @@ -2515,10 +2513,7 @@ example: "schemas": { "ErrorModel": { "type": "object", - "required": [ - "message", - "code" - ], + "required": ["message", "code"], "properties": { "message": { "type": "string" @@ -2537,9 +2532,7 @@ example: }, { "type": "object", - "required": [ - "rootCause" - ], + "required": ["rootCause"], "properties": { "rootCause": { "type": "string" @@ -2559,8 +2552,8 @@ components: ErrorModel: type: object required: - - message - - code + - message + - code properties: message: type: string @@ -2570,13 +2563,13 @@ components: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/components/schemas/ErrorModel' - - type: object - required: - - rootCause - properties: - rootCause: - type: string + - $ref: "#/components/schemas/ErrorModel" + - type: object + required: + - rootCause + properties: + rootCause: + type: string ``` ###### Models with Polymorphism Support @@ -2598,10 +2591,7 @@ components: "type": "string" } }, - "required": [ - "name", - "petType" - ] + "required": ["name", "petType"] }, "Cat": { "description": "A representation of a cat. Note that `Cat` will be used as the discriminator value.", @@ -2616,17 +2606,10 @@ components: "type": "string", "description": "The measured skill for hunting", "default": "lazy", - "enum": [ - "clueless", - "lazy", - "adventurous", - "aggressive" - ] + "enum": ["clueless", "lazy", "adventurous", "aggressive"] } }, - "required": [ - "huntingSkill" - ] + "required": ["huntingSkill"] } ] }, @@ -2647,9 +2630,7 @@ components: "minimum": 0 } }, - "required": [ - "packSize" - ] + "required": ["packSize"] } ] } @@ -2671,51 +2652,52 @@ components: petType: type: string required: - - name - - petType - Cat: ## "Cat" will be used as the discriminator value + - name + - petType + Cat: ## "Cat" will be used as the discriminator value description: A representation of a cat allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - huntingSkill: - type: string - description: The measured skill for hunting - enum: - - clueless - - lazy - - adventurous - - aggressive - required: - - huntingSkill - Dog: ## "Dog" will be used as the discriminator value + - $ref: "#/components/schemas/Pet" + - type: object + properties: + huntingSkill: + type: string + description: The measured skill for hunting + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill + Dog: ## "Dog" will be used as the discriminator value description: A representation of a dog allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - packSize: - type: integer - format: int32 - description: the size of the pack the dog is from - default: 0 - minimum: 0 - required: - - packSize + - $ref: "#/components/schemas/Pet" + - type: object + properties: + packSize: + type: integer + format: int32 + description: the size of the pack the dog is from + default: 0 + minimum: 0 + required: + - packSize ``` #### Discriminator Object -When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. +When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. When using the discriminator, _inline_ schemas will not be considered. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. - mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. + +| Field Name | Type | Description | +| ------------------------------------------- | :---------------------: | --------------------------------------------------------------------------------------------- | +| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. | +| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. | The discriminator attribute is legal only when using one of the composite keywords `oneOf`, `anyOf`, `allOf`. @@ -2729,8 +2711,7 @@ MyResponseType: - $ref: '#/components/schemas/Lizard' ``` -which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: - +which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: ``` MyResponseType: @@ -2742,7 +2723,7 @@ MyResponseType: propertyName: pet_type ``` -The expectation now is that a property with name `pet_type` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: +The expectation now is that a property with name `pet_type` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: ``` { @@ -2769,11 +2750,11 @@ MyResponseType: monster: 'https://gigantic-server.com/schemas/Monster/schema.json' ``` -Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. +Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. When used in conjunction with the `anyOf` construct, the use of the discriminator can avoid ambiguity where multiple schemas may satisfy a single payload. -In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. +In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. For example: @@ -2826,7 +2807,7 @@ a payload like this: } ``` -will indicate that the `Cat` schema be used. Likewise this schema: +will indicate that the `Cat` schema be used. Likewise this schema: ``` { @@ -2837,22 +2818,22 @@ will indicate that the `Cat` schema be used. Likewise this schema: will map to `Dog` because of the definition in the `mappings` element. - #### XML Object A metadata object that allows for more fine-tuned XML model definitions. -When using arrays, XML element names are *not* inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. +When using arrays, XML element names are _not_ inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. See examples for expected behavior. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. -namespace | `string` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. -prefix | `string` | The prefix to be used for the [name](#xmlName). -attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. -wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). + +| Field Name | Type | Description | +| ------------------------------------ | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. | +| prefix | `string` | The prefix to be used for the [name](#xmlName). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2866,9 +2847,9 @@ Basic string property: ```json { - "animals": { - "type": "string" - } + "animals": { + "type": "string" + } } ``` @@ -2885,12 +2866,12 @@ Basic string array property ([`wrapped`](#xmlWrapped) is `false` by default): ```json { - "animals": { - "type": "array", - "items": { - "type": "string" - } + "animals": { + "type": "array", + "items": { + "type": "string" } + } } ``` @@ -2931,7 +2912,6 @@ animals: ... ``` - ###### XML Attribute, Prefix and Namespace In this example, a full model definition is shown. @@ -3197,16 +3177,17 @@ Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06). ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. -description | `string` | Any | A short description for security scheme. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. -in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. -scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). -bearerFormat | `string` | `http` (`"bearer"`) | 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. -flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. -openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. + +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------- | :---------------------------------------: | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A short description for security scheme. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). | +| bearerFormat | `string` | `http` (`"bearer"`) | 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. | +| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3248,7 +3229,7 @@ in: header { "type": "http", "scheme": "bearer", - "bearerFormat": "JWT", + "bearerFormat": "JWT" } ``` @@ -3290,12 +3271,13 @@ flows: Allows configuration of the supported OAuth Flows. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -implicit| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow -password| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow -clientCredentials| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. -authorizationCode| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. + +| Field Name | Type | Description | +| ----------------------------------------------------------- | :-------------------------------------: | ---------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | +| clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3304,12 +3286,13 @@ This object MAY be extended with [Specification Extensions](#specification-exten Configuration details for a supported OAuth Flow ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. -tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. -refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. -scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. + +| Field Name | Type | Applies To | Description | +| -------------------------------------------------------- | :---------------------: | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3354,7 +3337,6 @@ flows: read:pets: read your pets ``` - #### Security Requirement Object Lists the required security schemes to execute this operation. @@ -3363,13 +3345,13 @@ The name used for each property MUST correspond to a security scheme declared in Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information. -When a list of Security Requirement Objects is defined on the [Open API object](#openapi-object) or [Operation Object](#operation-object), only one of Security Requirement Objects in the list needs to be satisfied to authorize the request. +When a list of Security Requirement Objects is defined on the [Open API object](#openapi-object) or [Operation Object](#operation-object), only one of Security Requirement Objects in the list needs to be satisfied to authorize the request. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. +| Field Pattern | Type | Description | +| --------------------------------------------- | :--------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. | ##### Security Requirement Object Examples @@ -3389,17 +3371,14 @@ api_key: [] ```json { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ``` ```yaml petstore_auth: -- write:pets -- read:pets + - write:pets + - read:pets ``` ### Specification Extensions @@ -3408,9 +3387,9 @@ While the OpenAPI Specification tries to accommodate most use cases, additional The extensions properties are implemented as patterned fields that are always prefixed by `"x-"`. -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. +| Field Pattern | Type | Description | +| -------------------------------- | :--: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. | The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). @@ -3428,14 +3407,14 @@ Two examples of this: ## Appendix A: Revision History -Version | Date | Notes ---- | --- | --- -3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 -3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification -3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification -3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification -2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative -2.0 | 2014-09-08 | Release of Swagger 2.0 -1.2 | 2014-03-14 | Initial release of the formal document. -1.1 | 2012-08-22 | Release of Swagger 1.1 -1.0 | 2011-08-10 | First release of the Swagger Specification +| Version | Date | Notes | +| --------- | ---------- | -------------------------------------------------- | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | diff --git a/3.0/3.0.1.md b/3.0/3.0.1.md index 2c1ba6c..f12d4e9 100644 --- a/3.0/3.0.1.md +++ b/3.0/3.0.1.md @@ -13,71 +13,75 @@ The OpenAPI Specification (OAS) defines a standard, language-agnostic interface An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. ## Table of Contents + - [Definitions](#definitions) - - [OpenAPI Document](#openapi-document) - - [Path Templating](#path-templating) - - [Media Types](#media-types) - - [HTTP Status Codes](#http-status-codes) + - [OpenAPI Document](#openapi-document) + - [Path Templating](#path-templating) + - [Media Types](#media-types) + - [HTTP Status Codes](#http-status-codes) - [Specification](#specification) - - [Versions](#versions) - - [Format](#format) - - [Document Structure](#document-structure) - - [Data Types](#data-types) - - [Rich Text Formatting](#rich-text-formatting) - - [Relative References In URLs](#relative-references-in-urls) - - [Schema](#schema) - - [OpenAPI Object](#openapi-object) - - [Info Object](#info-object) - - [Contact Object](#contact-object) - - [License Object](#license-object) - - [Server Object](#server-object) - - [Server Variable Object](#server-variable-object) - - [Components Object](#components-object) - - [Paths Object](#paths-object) - - [Path Item Object](#path-item-object) - - [Operation Object](#operation-object) - - [External Documentation Object](#external-documentation-object) - - [Parameter Object](#parameter-object) - - [Request Body Object](#request-body-object) - - [Media Type Object](#media-type-object) - - [Encoding Object](#encoding-object) - - [Responses Object](#responses-object) - - [Response Object](#response-object) - - [Callback Object](#callback-object) - - [Example Object](#example-object) - - [Link Object](#link-object) - - [Header Object](#header-object) - - [Tag Object](#tag-object) - - [Reference Object](#reference-object) - - [Schema Object](#schema-object) - - [Discriminator Object](#discriminator-object) - - [XML Object](#xml-object) - - [Security Scheme Object](#security-scheme-object) - - [OAuth Flows Object](#oauth-flows-object) - - [OAuth Flow Object](#oauth-flow-object) - - [Security Requirement Object](#security-requirement-object) - - [Specification Extensions](#specification-extensions) - - [Security Filtering](#security-filtering) + - [Versions](#versions) + - [Format](#format) + - [Document Structure](#document-structure) + - [Data Types](#data-types) + - [Rich Text Formatting](#rich-text-formatting) + - [Relative References In URLs](#relative-references-in-urls) + - [Schema](#schema) + - [OpenAPI Object](#openapi-object) + - [Info Object](#info-object) + - [Contact Object](#contact-object) + - [License Object](#license-object) + - [Server Object](#server-object) + - [Server Variable Object](#server-variable-object) + - [Components Object](#components-object) + - [Paths Object](#paths-object) + - [Path Item Object](#path-item-object) + - [Operation Object](#operation-object) + - [External Documentation Object](#external-documentation-object) + - [Parameter Object](#parameter-object) + - [Request Body Object](#request-body-object) + - [Media Type Object](#media-type-object) + - [Encoding Object](#encoding-object) + - [Responses Object](#responses-object) + - [Response Object](#response-object) + - [Callback Object](#callback-object) + - [Example Object](#example-object) + - [Link Object](#link-object) + - [Header Object](#header-object) + - [Tag Object](#tag-object) + - [Reference Object](#reference-object) + - [Schema Object](#schema-object) + - [Discriminator Object](#discriminator-object) + - [XML Object](#xml-object) + - [Security Scheme Object](#security-scheme-object) + - [OAuth Flows Object](#oauth-flows-object) + - [OAuth Flow Object](#oauth-flow-object) + - [Security Requirement Object](#security-requirement-object) + - [Specification Extensions](#specification-extensions) + - [Security Filtering](#security-filtering) - [Appendix A: Revision History](#appendix-a-revision-history) - ## Definitions ##### OpenAPI Document + A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification. ##### Path Templating + Path templating refers to the usage of curly braces ({}) to mark a section of a URL path as replaceable using path parameters. ##### Media Types + Media type definitions are spread across several resources. The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838). Some examples of possible media type definitions: + ``` text/plain; charset=utf-8 application/json @@ -90,7 +94,9 @@ Some examples of possible media type definitions: application/vnd.github.v3.diff application/vnd.github.v3.patch ``` + ##### HTTP Status Codes + The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are defined by [RFC7231](https://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). @@ -100,9 +106,9 @@ The available status codes are defined by [RFC7231](https://tools.ietf.org/html/ The OpenAPI Specification is versioned using [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) (semver) and follows the semver specification. -The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, *`.patch`* versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. +The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, _`.patch`_ versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. -Subsequent minor version releases of the OpenAPI Specification (incrementing the `minor` version number) SHOULD NOT interfere with tooling developed to a lower minor version and same major version. Thus a hypothetical `3.1.0` specification SHOULD be usable with tooling designed for `3.0.0`. +Subsequent minor version releases of the OpenAPI Specification (incrementing the `minor` version number) SHOULD NOT interfere with tooling developed to a lower minor version and same major version. Thus a hypothetical `3.1.0` specification SHOULD be usable with tooling designed for `3.0.0`. An OpenAPI document compatible with OAS 3.\*.\* contains a required [`openapi`](#oasVersion) field which designates the semantic version of the OAS that it uses. (OAS 2.0 documents contain a top-level version field named [`swagger`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerObject) and value `"2.0"`.) @@ -114,9 +120,10 @@ For example, if a field has an array value, the JSON array representation will b ```json { - "field": [ 1, 2, 3 ] + "field": [1, 2, 3] } ``` + All field names in the specification are **case sensitive**. The schema exposes two types of fields: Fixed fields, which have a declared name, and Patterned fields, which declare a regex pattern for the field name. @@ -151,21 +158,22 @@ Types that are not accompanied by a `format` property follow the type definition The formats defined by the OAS are: -Common Name | [`type`](#data-types) | [`format`](#dataTypeFormat) | Comments ------------ | ------ | -------- | -------- -integer | `integer` | `int32` | signed 32 bits -long | `integer` | `int64` | signed 64 bits -float | `number` | `float` | | -double | `number` | `double` | | -string | `string` | | | -byte | `string` | `byte` | base64 encoded characters -binary | `string` | `binary` | any sequence of octets -boolean | `boolean` | | | -date | `string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -password | `string` | `password` | A hint to UIs to obscure input. +| Common Name | [`type`](#data-types) | [`format`](#dataTypeFormat) | Comments | +| ----------- | --------------------- | --------------------------- | ------------------------------------------------------------------------------------------------ | +| integer | `integer` | `int32` | signed 32 bits | +| long | `integer` | `int64` | signed 64 bits | +| float | `number` | `float` | | +| double | `number` | `double` | | +| string | `string` | | | +| byte | `string` | `byte` | base64 encoded characters | +| binary | `string` | `binary` | any sequence of octets | +| boolean | `boolean` | | | +| date | `string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| password | `string` | `password` | A hint to UIs to obscure input. | ### Rich Text Formatting + Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting. Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by [CommonMark 0.27](http://spec.commonmark.org/0.27/). Tooling MAY choose to ignore some CommonMark features to address security concerns. @@ -186,16 +194,16 @@ This is the root document object of the [OpenAPI document](#openapi-document). ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string. -info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. -servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. -paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. -components | [Components Object](#components-object) | An element to hold various schemas for the specification. -security | [[Security Requirement Object](#security-requirement-object)] | 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. -tags | [[Tag Object](#tag-object)] | 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](#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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API [`info.version`](#infoVersion) string. | +| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. | +| paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. | +| components | [Components Object](#components-object) | An element to hold various schemas for the specification. | +| security | [[Security Requirement Object](#security-requirement-object)] | 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. | +| tags | [[Tag Object](#tag-object)] | 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -206,15 +214,14 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -title | `string` | **REQUIRED**. The title of the application. -description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. -contact | [Contact Object](#contact-object) | The contact information for the exposed API. -license | [License Object](#license-object) | The license information for the exposed API. -version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). - +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **REQUIRED**. The title of the application. | +| description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -258,11 +265,11 @@ Contact information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | The identifying name of the contact person/organization. -url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. -email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. +| Field Name | Type | Description | +| -------------------------------- | :------: | ------------------------------------------------------------------------------------------------ | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | +| email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -288,10 +295,10 @@ License information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The license name used for the API. -url | `string` | A URL to the license used for the API. MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------ | :------: | ---------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The license name used for the API. | +| url | `string` | A URL to the license used for the API. MUST be in the format of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -315,11 +322,11 @@ An object representing a Server. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. -description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. | +| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -362,12 +369,12 @@ The following shows how multiple servers can be described, for example, at the O ```yaml servers: -- url: https://development.gigantic-server.com/v1 - description: Development server -- url: https://staging.gigantic-server.com/v1 - description: Staging server -- url: https://api.gigantic-server.com/v1 - description: Production server + - url: https://development.gigantic-server.com/v1 + description: Development server + - url: https://staging.gigantic-server.com/v1 + description: Staging server + - url: https://api.gigantic-server.com/v1 + description: Production server ``` The following shows how variables can be used for a server configuration: @@ -384,10 +391,7 @@ The following shows how variables can be used for a server configuration: "description": "this value is assigned by the service provider, in this example `gigantic-server.com`" }, "port": { - "enum": [ - "8443", - "443" - ], + "enum": ["8443", "443"], "default": "8443" }, "basePath": { @@ -401,35 +405,34 @@ The following shows how variables can be used for a server configuration: ```yaml servers: -- url: https://{username}.gigantic-server.com:{port}/{basePath} - description: The production API server - variables: - username: - # note! no enum here means it is an open value - default: demo - description: this value is assigned by the service provider, in this example `gigantic-server.com` - port: - enum: - - '8443' - - '443' - default: '8443' - basePath: - # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` - default: v2 + - url: https://{username}.gigantic-server.com:{port}/{basePath} + description: The production API server + variables: + username: + # note! no enum here means it is an open value + default: demo + description: this value is assigned by the service provider, in this example `gigantic-server.com` + port: + enum: + - "8443" + - "443" + default: "8443" + basePath: + # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` + default: v2 ``` - #### Server Variable Object An object representing a Server Variable for server URL template substitution. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. -default | `string` | **REQUIRED**. The default value to use for substitution, and to send, if an alternate value is _not_ supplied. Unlike the [Schema Object's](#schema-object) `default`, this value MUST be provided by the consumer. -description | `string` | An optional description for the server variable. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. +| Field Name | Type | Description | +| --------------------------------------------------- | :--------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. | +| default | `string` | **REQUIRED**. The default value to use for substitution, and to send, if an alternate value is _not_ supplied. Unlike the [Schema Object's](#schema-object) `default`, this value MUST be provided by the consumer. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -438,20 +441,19 @@ This object MAY be extended with [Specification Extensions](#specification-exten Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. - ##### Fixed Fields -Field Name | Type | Description ----|:---|--- - schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). - responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). - parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). - examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). - requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). - headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). - securitySchemes| Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). - links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). - callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). +| Field Name | Type | Description | +| -------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). | +| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | +| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | +| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | +| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | +| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -605,7 +607,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GeneralError' + $ref: "#/components/schemas/GeneralError" securitySchemes: api_key: type: apiKey @@ -621,17 +623,16 @@ components: read:pets: read your pets ``` - #### Paths Object Holds the relative paths to the individual endpoints and their operations. -The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#security-filtering). +The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#security-filtering). ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -/{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. +| Field Pattern | Type | Description | +| ------------------------------- | :-----------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -666,7 +667,7 @@ The following may lead to ambiguous resolution: "get": { "description": "Returns all pets from the system that the user has access to", "responses": { - "200": { + "200": { "description": "A list of pets.", "content": { "application/json": { @@ -690,14 +691,14 @@ The following may lead to ambiguous resolution: get: description: Returns all pets from the system that the user has access to responses: - '200': + "200": description: A list of pets. content: application/json: schema: type: array items: - $ref: '#/components/schemas/pet' + $ref: "#/components/schemas/pet" ``` #### Path Item Object @@ -708,22 +709,21 @@ The path itself is still exposed to the documentation viewer but they will not k ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is *undefined*. -summary| `string` | An optional, string summary, intended to apply to all operations in this path. -description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -get | [Operation Object](#operation-object) | A definition of a GET operation on this path. -put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. -post | [Operation Object](#operation-object) | A definition of a POST operation on this path. -delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. -options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. -head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. -patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. -trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. -servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). - +| Field Name | Type | Description | +| --------------------------------------------- | :------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is _undefined_. | +| summary | `string` | An optional, string summary, intended to apply to all operations in this path. | +| description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | +| servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -785,30 +785,30 @@ get: summary: Find pets by ID operationId: getPetsById responses: - '200': + "200": description: pet response content: - '*/*' : + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: - 'text/html': + "text/html": schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" parameters: -- name: id - in: path - description: ID of pet to use - required: true - schema: - type: array - style: simple - items: - type: string + - name: id + in: path + description: ID of pet to use + required: true + schema: + type: array + style: simple + items: + type: string ``` #### Operation Object @@ -817,20 +817,20 @@ Describes a single API operation on a path. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. -summary | `string` | A short summary of what the operation does. -description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. -operationId | `string` | 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. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). -requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. -responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. -callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#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. -deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. -security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. -servers | [[Server Object](#server-object)] | 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. +| Field Name | Type | Description | +| ------------------------------------------------ | :-----------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. | +| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | 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. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | +| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. | +| responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#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. | +| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. | +| servers | [[Server Object](#server-object)] | 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -838,9 +838,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "tags": [ - "pet" - ], + "tags": ["pet"], "summary": "Updates a pet in the store with form data", "operationId": "updatePetWithForm", "parameters": [ @@ -859,17 +857,17 @@ This object MAY be extended with [Specification Extensions](#specification-exten "application/x-www-form-urlencoded": { "schema": { "type": "object", - "properties": { - "name": { - "description": "Updated name of the pet", - "type": "string" - }, - "status": { - "description": "Updated status of the pet", - "type": "string" - } - }, - "required": ["status"] + "properties": { + "name": { + "description": "Updated name of the pet", + "type": "string" + }, + "status": { + "description": "Updated status of the pet", + "type": "string" + } + }, + "required": ["status"] } } } @@ -892,10 +890,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten }, "security": [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] } @@ -903,57 +898,56 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```yaml tags: -- pet + - pet summary: Updates a pet in the store with form data operationId: updatePetWithForm parameters: -- name: petId - in: path - description: ID of pet that needs to be updated - required: true - schema: - type: string + - name: petId + in: path + description: ID of pet that needs to be updated + required: true + schema: + type: string requestBody: content: - 'application/x-www-form-urlencoded': + "application/x-www-form-urlencoded": schema: - properties: + properties: name: description: Updated name of the pet type: string status: description: Updated status of the pet type: string - required: - - status + required: + - status responses: - '200': + "200": description: Pet updated. content: - 'application/json': {} - 'application/xml': {} - '405': + "application/json": {} + "application/xml": {} + "405": description: Invalid input content: - 'application/json': {} - 'application/xml': {} + "application/json": {} + "application/xml": {} security: -- petstore_auth: - - write:pets - - read:pets + - petstore_auth: + - write:pets + - read:pets ``` - #### External Documentation Object Allows referencing an external resource for extended documentation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -978,58 +972,58 @@ Describes a single operation parameter. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). ##### Parameter Locations -There are four possible parameter locations specified by the `in` field: -* path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. -* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. -* cookie - Used to pass a specific cookie value to the API. +There are four possible parameter locations specified by the `in` field: + +- path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +- header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. +- cookie - Used to pass a specific cookie value to the API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
-in | `string` | **REQUIRED**. The location of the parameter. Possible values are "query", "header", "path" or "cookie". -description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is "path", this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. - deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. - allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. + +| Field Name | Type | Description | +| ------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
| +| in | `string` | **REQUIRED**. The location of the parameter. Possible values are "query", "header", "path" or "cookie". | +| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is "path", this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | +| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. | +| allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. | The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a [`schema`](#parameterSchema) and [`style`](#parameterStyle) can describe the structure and syntax of the parameter. -Field Name | Type | Description ----|:---:|--- -style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. -explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. -schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. -example | Any | Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. +| Field Name | Type | Description | +| -------------------------------------------------- | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. | +| explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. | +| example | Any | Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. A parameter MUST contain either a `schema` property, or a `content` property, but not both. When `example` or `examples` are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the parameter. - -Field Name | Type | Description ----|:---:|--- -content | Map[`string`, [Media Type Object](#media-type-object)] | 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. +| Field Name | Type | Description | +| -------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| content | Map[`string`, [Media Type Object](#media-type-object)] | 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. | ##### Style Values In order to support common ways of serializing simple parameters, a set of `style` values are defined. -`style` | [`type`](#data-types) | `in` | Comments ------------ | ------ | -------- | -------- -matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) -label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) -form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. -simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. -spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. -pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. -deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. - +| `style` | [`type`](#data-types) | `in` | Comments | +| -------------- | ------------------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. | ##### Style Examples @@ -1040,21 +1034,22 @@ Assume a parameter named `color` has one of the following values: array -> ["blue","black","brown"] object -> { "R": 100, "G": 200, "B": 150 } ``` + The following table shows examples of rendering differences for each value. -[`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` ------------ | ------ | -------- | -------- | --------|------- -matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 -matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 -label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 -label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 -form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 -form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 -simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 -simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 -spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 -pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200|G\|150 -deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 +| [`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` | +| -------------------------- | --------- | ------- | ----------- | ----------------------------------- | -------------------------------------- | ------ | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +| simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 | +| spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 | +| pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200 | G\|150 | +| deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1093,6 +1088,7 @@ style: simple ``` A path parameter of a string value: + ```json { "name": "username", @@ -1115,6 +1111,7 @@ schema: ``` An optional query parameter of a string value, allowing multiple values by repeating the query parameter: + ```json { "name": "id", @@ -1146,6 +1143,7 @@ explode: true ``` A free-form query parameter, allowing undefined parameters of a specific type: + ```json { "in": "query", @@ -1154,7 +1152,7 @@ A free-form query parameter, allowing undefined parameters of a specific type: "type": "object", "additionalProperties": { "type": "integer" - }, + } }, "style": "form" } @@ -1180,10 +1178,7 @@ A complex parameter using `content` to define serialization: "application/json": { "schema": { "type": "object", - "required": [ - "lat", - "long" - ], + "required": ["lat", "long"], "properties": { "lat": { "type": "number" @@ -1220,18 +1215,19 @@ content: Describes a single request body. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. +| Field Name | Type | Description | +| ------------------------------------------------ | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ##### Request Body Examples A request body with a referenced model definition. + ```json { "description": "user to add to the system", @@ -1241,36 +1237,36 @@ A request body with a referenced model definition. "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User Example", - "externalValue": "http://foo.bar/examples/user-example.json" - } + "user": { + "summary": "User Example", + "externalValue": "http://foo.bar/examples/user-example.json" } + } }, "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User example in XML", - "externalValue": "http://foo.bar/examples/user-example.xml" - } + "user": { + "summary": "User example in XML", + "externalValue": "http://foo.bar/examples/user-example.xml" } + } }, "text/plain": { "examples": { - "user" : { - "summary": "User example in Plain text", - "externalValue": "http://foo.bar/examples/user-example.txt" + "user": { + "summary": "User example in Plain text", + "externalValue": "http://foo.bar/examples/user-example.txt" } } }, "*/*": { "examples": { - "user" : { - "summary": "User example in other format", - "externalValue": "http://foo.bar/examples/user-example.whatever" + "user": { + "summary": "User example in other format", + "externalValue": "http://foo.bar/examples/user-example.whatever" } } } @@ -1281,33 +1277,34 @@ A request body with a referenced model definition. ```yaml description: user to add to the system content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example - externalValue: 'http://foo.bar/examples/user-example.json' - 'application/xml': + externalValue: "http://foo.bar/examples/user-example.json" + "application/xml": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example in XML - externalValue: 'http://foo.bar/examples/user-example.xml' - 'text/plain': + externalValue: "http://foo.bar/examples/user-example.xml" + "text/plain": examples: user: summary: User example in text plain format - externalValue: 'http://foo.bar/examples/user-example.txt' - '*/*': + externalValue: "http://foo.bar/examples/user-example.txt" + "*/*": examples: user: summary: User example in other format - externalValue: 'http://foo.bar/examples/user-example.whatever' + externalValue: "http://foo.bar/examples/user-example.whatever" ``` A body parameter that is an array of string values: + ```json { "description": "user to add to the system", @@ -1335,17 +1332,18 @@ content: type: string ``` - #### Media Type Object + Each Media Type Object provides schema and examples for the media type identified by its key. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the request body. -example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. -encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. + +| Field Name | Type | Description | +| ---------------------------------------- | :----------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the request body. | +| example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1451,15 +1449,15 @@ In addition, specific media types MAY be specified: # multiple, specific media types may be specified: requestBody: content: - # a binary file of type png or jpeg - 'image/jpeg': + # a binary file of type png or jpeg + "image/jpeg": schema: type: string format: binary - 'image/png': + "image/png": schema: type: string - format: binary + format: binary ``` To upload multiple files, a `multipart` media type MUST be used: @@ -1476,7 +1474,6 @@ requestBody: items: type: string format: binary - ``` ##### Support for x-www-form-urlencoded Request Bodies @@ -1500,20 +1497,19 @@ requestBody: properties: {} ``` -In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. +In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. When passing complex objects in the `application/x-www-form-urlencoded` content type, the default serialization strategy of such properties is described in the [`Encoding Object`](#encoding-object)'s [`style`](#encodingStyle) property as `form`. ##### Special Considerations for `multipart` Content -It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. +It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. When passing in `multipart` types, boundaries MAY be used to separate sections of the content being transferred — thus, the following default `Content-Type`s are defined for `multipart`: -* If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` -* If the property is complex, or an array of complex values, the default Content-Type is `application/json` -* If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` - +- If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` +- If the property is complex, or an array of complex values, the default Content-Type is `application/json` +- If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` Examples: @@ -1544,23 +1540,24 @@ requestBody: # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example) type: array items: - type: '#/components/schemas/Address' + type: "#/components/schemas/Address" ``` -An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. +An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. #### Encoding Object A single encoding definition applied to a single schema property. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. -style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. + +| Field Name | Type | Description | +| ------------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. | +| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1619,15 +1616,16 @@ The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. + +| Field Name | Type | Description | +| -------------------------------------- | :--------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -[HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. The following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response range is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. +| Field Pattern | Type | Description | +| ------------------------------------------------------------------ | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. The following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response range is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1661,31 +1659,33 @@ A 200 response for a successful operation and a default response for others (imp ``` ```yaml -'200': +"200": description: a pet to be returned content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: Unexpected error content: application/json: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` #### Response Object + Describes a single response from an API Operation, including design-time, static `links` to operations based on the response. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. -content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* -links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). + +| Field Name | Type | Description | +| --------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/\* | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1716,7 +1716,7 @@ content: schema: type: array items: - $ref: '#/components/schemas/VeryComplexType' + $ref: "#/components/schemas/VeryComplexType" ``` Response with a string type: @@ -1731,7 +1731,6 @@ Response with a string type: } } } - } ``` @@ -1784,7 +1783,7 @@ content: text/plain: schema: type: string - example: 'whoa!' + example: "whoa!" headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period @@ -1819,9 +1818,10 @@ Each value in the map is a [Path Item Object](#path-item-object) that describes 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. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. + +| Field Pattern | Type | Description | +| --------------------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1855,17 +1855,16 @@ Location: http://example.org/subscription/1 The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. -Expression | Value ----|:--- -$url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning -$method | POST -$request.path.eventType | myevent -$request.query.queryUrl | http://clientdomain.com/stillrunning -$request.header.content-Type | application/json -$request.body#/failedUrl | http://clientdomain.com/stillrunning -$request.body#/successUrls/2 | http://clientdomain.com/medium -$response.header.Location | http://example.org/subscription/1 - +| Expression | Value | +| ---------------------------- | :--------------------------------------------------------------------------------- | +| $url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | http://clientdomain.com/stillrunning | +| $request.header.content-Type | application/json | +| $request.body#/failedUrl | http://clientdomain.com/stillrunning | +| $request.body#/successUrls/2 | http://clientdomain.com/medium | +| $response.header.Location | http://example.org/subscription/1 | ##### Callback Object Example @@ -1873,34 +1872,34 @@ The following example shows a callback to the URL specified by the `id` and `ema ```yaml myWebhook: - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + "http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}": post: requestBody: description: Callback payload content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: webhook successfully processed and no retries will be performed ``` - #### Example Object ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -summary | `string` | Short description for the example. -description | `string` | Long description for the example. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. -externalValue | `string` | A 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. + +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | Short description for the example. | +| description | `string` | Long description for the example. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | +| externalValue | `string` | A 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). In all cases, the example value is expected to be compatible with the type schema -of its associated value. Tooling implementations MAY choose to +of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible. ##### Example Object Example @@ -1915,56 +1914,54 @@ schemas: name: $ref: http://example.org/petapi-examples/openapi.json#/components/examples/name-example -# in a request body: + # in a request body: requestBody: content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" examples: foo: summary: A foo example - value: {"foo": "bar"} + value: { "foo": "bar" } bar: summary: A bar example - value: {"bar": "baz"} - 'application/xml': + value: { "bar": "baz" } + "application/xml": examples: xmlExample: summary: This is an example in XML - externalValue: 'http://example.org/examples/address-example.xml' - 'text/plain': + externalValue: "http://example.org/examples/address-example.xml" + "text/plain": examples: textExample: summary: This is a text example - externalValue: 'http://foo.bar/examples/address-example.txt' + externalValue: "http://foo.bar/examples/address-example.txt" - -# in a parameter + # in a parameter parameters: - - name: 'zipCode' - in: 'query' + - name: "zipCode" + in: "query" schema: - type: 'string' - format: 'zip-code' + type: "string" + format: "zip-code" examples: zip-example: - $ref: '#/components/examples/zip-example' + $ref: "#/components/examples/zip-example" -# in a response + # in a response responses: - '200': + "200": description: your car appointment has been booked content: application/json: schema: - $ref: '#/components/schemas/SuccessResponse' + $ref: "#/components/schemas/SuccessResponse" examples: confirmation-success: - $ref: '#/components/examples/confirmation-success' + $ref: "#/components/examples/confirmation-success" ``` - #### Link Object The `Link object` represents a possible design-time link for a response. @@ -1972,18 +1969,18 @@ The presence of a link does not guarantee the caller's ability to successfully i Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response. -For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. +For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -operationRef | `string` | A relative or absolute reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. -operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. -parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). -requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. -description | `string` | A description of the link. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -server | [Server Object](#server-object) | A server object to be used by the target operation. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| operationRef | `string` | A relative or absolute reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). | +| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#server-object) | A server object to be used by the target operation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2000,15 +1997,15 @@ Computing a link from a request operation where the `$request.path.id` is used t paths: /users/{id}: parameters: - - name: id - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: id + in: path + required: true + description: the user identifier, as userId + schema: + type: string get: responses: - '200': + "200": description: the user being returned content: application/json: @@ -2028,17 +2025,17 @@ paths: # the path item of the linked operation /users/{userid}/address: parameters: - - name: userid - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: userid + in: path + required: true + description: the user identifier, as userId + schema: + type: string # linked operation get: operationId: getUserAddress responses: - '200': + "200": description: the user's address ``` @@ -2059,7 +2056,6 @@ Clients follow all links at their discretion. Neither permissions, nor the capability to make a successful call to that link, is guaranteed solely by the existence of a relationship. - ##### OperationRef Examples As references to `operationId` MAY NOT be possible (the `operationId` is an optional @@ -2069,7 +2065,7 @@ value), references MAY also be made through a relative `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: '#/paths/~12.0~1repositories~1{username}/get' + operationRef: "#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2080,7 +2076,7 @@ or an absolute `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: 'https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get' + operationRef: "https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2088,7 +2084,6 @@ links: Note that in the use of `operationRef`, the _escaped forward-slash_ is necessary when using JSON references. - ##### Runtime Expressions Runtime expressions allow defining values based on information that will only be available within the HTTP message in an actual API call. @@ -2098,12 +2093,12 @@ The runtime expression is defined by the following [ABNF](https://tools.ietf.org ``` expression = ( "$url" | "$method" | "$statusCode" | "$request." source | "$response." source ) - source = ( header-reference | query-reference | path-reference | body-reference ) + source = ( header-reference | query-reference | path-reference | body-reference ) header-reference = "header." token - query-reference = "query." name + query-reference = "query." name path-reference = "path." name body-reference = "body" ["#" fragment] - fragment = a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901) + fragment = a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901) name = *( char ) char = as per RFC [7159](https://tools.ietf.org/html/rfc7159#section-7) token = as per RFC [7230](https://tools.ietf.org/html/rfc7230#section-3.2.6) @@ -2115,15 +2110,15 @@ The table below provides examples of runtime expressions and examples of their u ##### Examples -Source Location | example expression | notes ----|:---|:---| -HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. -Requested media type | `$request.header.accept` | -Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. -Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. -Request URL | `$url` | -Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. -Response header | `$response.header.Server` | Single header values only are available +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | Runtime expressions preserve the type of the referenced value. Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. @@ -2161,11 +2156,12 @@ Adds metadata to a single tag that is used by the [Operation Object](#operation- It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the tag. -description | `string` | A short description for the tag. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. + +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the tag. | +| description | `string` | A short description for the tag. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2173,8 +2169,8 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "name": "pet", - "description": "Pets operations" + "name": "pet", + "description": "Pets operations" } ``` @@ -2183,7 +2179,6 @@ name: pet description: Pets operations ``` - #### Reference Object A simple object to allow referencing other components in the specification, internally and externally. @@ -2193,9 +2188,10 @@ The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/ For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | **REQUIRED**. The reference string. + +| Field Name | Type | Description | +| ------------------------------- | :------: | ----------------------------------- | +| $ref | `string` | **REQUIRED**. The reference string. | This object cannot be extended with additional properties and any properties added SHALL be ignored. @@ -2203,15 +2199,16 @@ This object cannot be extended with additional properties and any properties add ```json { - "$ref": "#/components/schemas/Pet" + "$ref": "#/components/schemas/Pet" } ``` ```yaml -$ref: '#/components/schemas/Pet' +$ref: "#/components/schemas/Pet" ``` ##### Relative Schema Document Example + ```json { "$ref": "Pet.json" @@ -2223,6 +2220,7 @@ $ref: Pet.yaml ``` ##### Relative Documents With Embedded Schema Example + ```json { "$ref": "definitions.json#/Pet" @@ -2264,6 +2262,7 @@ The following properties are taken directly from the JSON Schema definition and - enum The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification. + - type - Value MUST be a string. Multiple types via an array are not supported. - allOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. - oneOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. @@ -2283,32 +2282,34 @@ Additional properties defined by the JSON Schema specification that are not ment Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation: ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`. -discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. -readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". 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`. -writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". 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`. -xml | [XML Object](#xml-object) | 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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. -example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. - deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. + +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`. | +| discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. | +| readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". 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`. | +| writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". 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`. | +| xml | [XML Object](#xml-object) | 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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. | +| deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ###### Composition and Inheritance (Polymorphism) The OpenAPI Specification allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition. -`allOf` takes an array of object definitions that are validated *independently* but together compose a single object. +`allOf` takes an array of object definitions that are validated _independently_ but together compose a single object. While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, the OpenAPI Specification adds the `discriminator` field. When used, the `discriminator` will be the name of the property that decides which schema definition validates the structure of the model. As such, the `discriminator` field MUST be a required field. There are two ways to define the value of a discriminator for an inheriting instance. + - Use the schema name. - Override the schema name by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. -As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism. + As such, inline schema definitions, which do not have a given id, _cannot_ be used in polymorphism. ###### XML Modeling @@ -2336,9 +2337,7 @@ format: email ```json { "type": "object", - "required": [ - "name" - ], + "required": ["name"], "properties": { "name": { "type": "string" @@ -2358,12 +2357,12 @@ format: email ```yaml type: object required: -- name + - name properties: name: type: string address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" age: type: integer format: int32 @@ -2403,7 +2402,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/components/schemas/ComplexModel' + $ref: "#/components/schemas/ComplexModel" ``` ###### Model with Example @@ -2420,9 +2419,7 @@ additionalProperties: "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "example": { "name": "Puma", "id": 1 @@ -2439,7 +2436,7 @@ properties: name: type: string required: -- name + - name example: name: Puma id: 1 @@ -2453,10 +2450,7 @@ example: "schemas": { "ErrorModel": { "type": "object", - "required": [ - "message", - "code" - ], + "required": ["message", "code"], "properties": { "message": { "type": "string" @@ -2475,9 +2469,7 @@ example: }, { "type": "object", - "required": [ - "rootCause" - ], + "required": ["rootCause"], "properties": { "rootCause": { "type": "string" @@ -2497,8 +2489,8 @@ components: ErrorModel: type: object required: - - message - - code + - message + - code properties: message: type: string @@ -2508,13 +2500,13 @@ components: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/components/schemas/ErrorModel' - - type: object - required: - - rootCause - properties: - rootCause: - type: string + - $ref: "#/components/schemas/ErrorModel" + - type: object + required: + - rootCause + properties: + rootCause: + type: string ``` ###### Models with Polymorphism Support @@ -2536,10 +2528,7 @@ components: "type": "string" } }, - "required": [ - "name", - "petType" - ] + "required": ["name", "petType"] }, "Cat": { "description": "A representation of a cat. Note that `Cat` will be used as the discriminator value.", @@ -2554,17 +2543,10 @@ components: "type": "string", "description": "The measured skill for hunting", "default": "lazy", - "enum": [ - "clueless", - "lazy", - "adventurous", - "aggressive" - ] + "enum": ["clueless", "lazy", "adventurous", "aggressive"] } }, - "required": [ - "huntingSkill" - ] + "required": ["huntingSkill"] } ] }, @@ -2585,9 +2567,7 @@ components: "minimum": 0 } }, - "required": [ - "packSize" - ] + "required": ["packSize"] } ] } @@ -2609,51 +2589,52 @@ components: petType: type: string required: - - name - - petType - Cat: ## "Cat" will be used as the discriminator value + - name + - petType + Cat: ## "Cat" will be used as the discriminator value description: A representation of a cat allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - huntingSkill: - type: string - description: The measured skill for hunting - enum: - - clueless - - lazy - - adventurous - - aggressive - required: - - huntingSkill - Dog: ## "Dog" will be used as the discriminator value + - $ref: "#/components/schemas/Pet" + - type: object + properties: + huntingSkill: + type: string + description: The measured skill for hunting + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill + Dog: ## "Dog" will be used as the discriminator value description: A representation of a dog allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - packSize: - type: integer - format: int32 - description: the size of the pack the dog is from - default: 0 - minimum: 0 - required: - - packSize + - $ref: "#/components/schemas/Pet" + - type: object + properties: + packSize: + type: integer + format: int32 + description: the size of the pack the dog is from + default: 0 + minimum: 0 + required: + - packSize ``` #### Discriminator Object -When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. +When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. When using the discriminator, _inline_ schemas will not be considered. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. - mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. + +| Field Name | Type | Description | +| ------------------------------------------- | :---------------------: | --------------------------------------------------------------------------------------------- | +| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. | +| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. | The discriminator attribute is legal only when using one of the composite keywords `oneOf`, `anyOf`, `allOf`. @@ -2667,8 +2648,7 @@ MyResponseType: - $ref: '#/components/schemas/Lizard' ``` -which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: - +which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: ``` MyResponseType: @@ -2680,7 +2660,7 @@ MyResponseType: propertyName: pet_type ``` -The expectation now is that a property with name `pet_type` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: +The expectation now is that a property with name `pet_type` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: ``` { @@ -2707,11 +2687,11 @@ MyResponseType: monster: 'https://gigantic-server.com/schemas/Monster/schema.json' ``` -Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. +Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. When used in conjunction with the `anyOf` construct, the use of the discriminator can avoid ambiguity where multiple schemas may satisfy a single payload. -In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. +In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. For example: @@ -2764,7 +2744,7 @@ a payload like this: } ``` -will indicate that the `Cat` schema be used. Likewise this schema: +will indicate that the `Cat` schema be used. Likewise this schema: ``` { @@ -2775,22 +2755,22 @@ will indicate that the `Cat` schema be used. Likewise this schema: will map to `Dog` because of the definition in the `mappings` element. - #### XML Object A metadata object that allows for more fine-tuned XML model definitions. -When using arrays, XML element names are *not* inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. +When using arrays, XML element names are _not_ inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. See examples for expected behavior. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. -namespace | `string` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. -prefix | `string` | The prefix to be used for the [name](#xmlName). -attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. -wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). + +| Field Name | Type | Description | +| ------------------------------------ | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. | +| prefix | `string` | The prefix to be used for the [name](#xmlName). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2804,9 +2784,9 @@ Basic string property: ```json { - "animals": { - "type": "string" - } + "animals": { + "type": "string" + } } ``` @@ -2823,12 +2803,12 @@ Basic string array property ([`wrapped`](#xmlWrapped) is `false` by default): ```json { - "animals": { - "type": "array", - "items": { - "type": "string" - } + "animals": { + "type": "array", + "items": { + "type": "string" } + } } ``` @@ -2869,7 +2849,6 @@ animals: ... ``` - ###### XML Attribute, Prefix and Namespace In this example, a full model definition is shown. @@ -3135,16 +3114,17 @@ Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06). ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. -description | `string` | Any | A short description for security scheme. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. -in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. -scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). -bearerFormat | `string` | `http` (`"bearer"`) | 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. -flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. -openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. + +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------- | :---------------------------------------: | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A short description for security scheme. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). | +| bearerFormat | `string` | `http` (`"bearer"`) | 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. | +| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3186,7 +3166,7 @@ in: header { "type": "http", "scheme": "bearer", - "bearerFormat": "JWT", + "bearerFormat": "JWT" } ``` @@ -3228,12 +3208,13 @@ flows: Allows configuration of the supported OAuth Flows. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -implicit| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow -password| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow -clientCredentials| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. -authorizationCode| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. + +| Field Name | Type | Description | +| ----------------------------------------------------------- | :-------------------------------------: | ---------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | +| clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3242,12 +3223,13 @@ This object MAY be extended with [Specification Extensions](#specification-exten Configuration details for a supported OAuth Flow ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. -tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. -refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. -scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. + +| Field Name | Type | Applies To | Description | +| -------------------------------------------------------- | :---------------------: | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3292,7 +3274,6 @@ flows: read:pets: read your pets ``` - #### Security Requirement Object Lists the required security schemes to execute this operation. @@ -3301,13 +3282,13 @@ The name used for each property MUST correspond to a security scheme declared in Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information. -When a list of Security Requirement Objects is defined on the [Open API object](#openapi-object) or [Operation Object](#operation-object), only one of Security Requirement Objects in the list needs to be satisfied to authorize the request. +When a list of Security Requirement Objects is defined on the [Open API object](#openapi-object) or [Operation Object](#operation-object), only one of Security Requirement Objects in the list needs to be satisfied to authorize the request. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. +| Field Pattern | Type | Description | +| --------------------------------------------- | :--------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. | ##### Security Requirement Object Examples @@ -3327,17 +3308,14 @@ api_key: [] ```json { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ``` ```yaml petstore_auth: -- write:pets -- read:pets + - write:pets + - read:pets ``` ### Specification Extensions @@ -3346,9 +3324,9 @@ While the OpenAPI Specification tries to accommodate most use cases, additional The extensions properties are implemented as patterned fields that are always prefixed by `"x-"`. -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. +| Field Pattern | Type | Description | +| -------------------------------- | :--: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. | The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). @@ -3366,15 +3344,15 @@ Two examples of this: ## Appendix A: Revision History -Version | Date | Notes ---- | --- | --- -3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 -3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 -3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification -3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification -3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification -2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative -2.0 | 2014-09-08 | Release of Swagger 2.0 -1.2 | 2014-03-14 | Initial release of the formal document. -1.1 | 2012-08-22 | Release of Swagger 1.1 -1.0 | 2011-08-10 | First release of the Swagger Specification +| Version | Date | Notes | +| --------- | ---------- | -------------------------------------------------- | +| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | diff --git a/3.0/3.0.2.md b/3.0/3.0.2.md index ff86a52..1dfdcfc 100644 --- a/3.0/3.0.2.md +++ b/3.0/3.0.2.md @@ -13,71 +13,75 @@ The OpenAPI Specification (OAS) defines a standard, language-agnostic interface An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. ## Table of Contents + - [Definitions](#definitions) - - [OpenAPI Document](#openapi-document) - - [Path Templating](#path-templating) - - [Media Types](#media-types) - - [HTTP Status Codes](#http-status-codes) + - [OpenAPI Document](#openapi-document) + - [Path Templating](#path-templating) + - [Media Types](#media-types) + - [HTTP Status Codes](#http-status-codes) - [Specification](#specification) - - [Versions](#versions) - - [Format](#format) - - [Document Structure](#document-structure) - - [Data Types](#data-types) - - [Rich Text Formatting](#rich-text-formatting) - - [Relative References In URLs](#relative-references-in-urls) - - [Schema](#schema) - - [OpenAPI Object](#openapi-object) - - [Info Object](#info-object) - - [Contact Object](#contact-object) - - [License Object](#license-object) - - [Server Object](#server-object) - - [Server Variable Object](#server-variable-object) - - [Components Object](#components-object) - - [Paths Object](#paths-object) - - [Path Item Object](#path-item-object) - - [Operation Object](#operation-object) - - [External Documentation Object](#external-documentation-object) - - [Parameter Object](#parameter-object) - - [Request Body Object](#request-body-object) - - [Media Type Object](#media-type-object) - - [Encoding Object](#encoding-object) - - [Responses Object](#responses-object) - - [Response Object](#response-object) - - [Callback Object](#callback-object) - - [Example Object](#example-object) - - [Link Object](#link-object) - - [Header Object](#header-object) - - [Tag Object](#tag-object) - - [Reference Object](#reference-object) - - [Schema Object](#schema-object) - - [Discriminator Object](#discriminator-object) - - [XML Object](#xml-object) - - [Security Scheme Object](#security-scheme-object) - - [OAuth Flows Object](#oauth-flows-object) - - [OAuth Flow Object](#oauth-flow-object) - - [Security Requirement Object](#security-requirement-object) - - [Specification Extensions](#specification-extensions) - - [Security Filtering](#security-filtering) + - [Versions](#versions) + - [Format](#format) + - [Document Structure](#document-structure) + - [Data Types](#data-types) + - [Rich Text Formatting](#rich-text-formatting) + - [Relative References In URLs](#relative-references-in-urls) + - [Schema](#schema) + - [OpenAPI Object](#openapi-object) + - [Info Object](#info-object) + - [Contact Object](#contact-object) + - [License Object](#license-object) + - [Server Object](#server-object) + - [Server Variable Object](#server-variable-object) + - [Components Object](#components-object) + - [Paths Object](#paths-object) + - [Path Item Object](#path-item-object) + - [Operation Object](#operation-object) + - [External Documentation Object](#external-documentation-object) + - [Parameter Object](#parameter-object) + - [Request Body Object](#request-body-object) + - [Media Type Object](#media-type-object) + - [Encoding Object](#encoding-object) + - [Responses Object](#responses-object) + - [Response Object](#response-object) + - [Callback Object](#callback-object) + - [Example Object](#example-object) + - [Link Object](#link-object) + - [Header Object](#header-object) + - [Tag Object](#tag-object) + - [Reference Object](#reference-object) + - [Schema Object](#schema-object) + - [Discriminator Object](#discriminator-object) + - [XML Object](#xml-object) + - [Security Scheme Object](#security-scheme-object) + - [OAuth Flows Object](#oauth-flows-object) + - [OAuth Flow Object](#oauth-flow-object) + - [Security Requirement Object](#security-requirement-object) + - [Specification Extensions](#specification-extensions) + - [Security Filtering](#security-filtering) - [Appendix A: Revision History](#appendix-a-revision-history) - ## Definitions ##### OpenAPI Document + A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification. ##### Path Templating + Path templating refers to the usage of curly braces ({}) to mark a section of a URL path as replaceable using path parameters. ##### Media Types + Media type definitions are spread across several resources. The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838). Some examples of possible media type definitions: + ``` text/plain; charset=utf-8 application/json @@ -90,7 +94,9 @@ Some examples of possible media type definitions: application/vnd.github.v3.diff application/vnd.github.v3.patch ``` + ##### HTTP Status Codes + The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are defined by [RFC7231](https://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). @@ -100,9 +106,9 @@ The available status codes are defined by [RFC7231](https://tools.ietf.org/html/ The OpenAPI Specification is versioned using [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) (semver) and follows the semver specification. -The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, *`.patch`* versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. +The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, _`.patch`_ versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. -Subsequent minor version releases of the OpenAPI Specification (incrementing the `minor` version number) SHOULD NOT interfere with tooling developed to a lower minor version and same major version. Thus a hypothetical `3.1.0` specification SHOULD be usable with tooling designed for `3.0.0`. +Subsequent minor version releases of the OpenAPI Specification (incrementing the `minor` version number) SHOULD NOT interfere with tooling developed to a lower minor version and same major version. Thus a hypothetical `3.1.0` specification SHOULD be usable with tooling designed for `3.0.0`. An OpenAPI document compatible with OAS 3.\*.\* contains a required [`openapi`](#oasVersion) field which designates the semantic version of the OAS that it uses. (OAS 2.0 documents contain a top-level version field named [`swagger`](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerObject) and value `"2.0"`.) @@ -114,9 +120,10 @@ For example, if a field has an array value, the JSON array representation will b ```json { - "field": [ 1, 2, 3 ] + "field": [1, 2, 3] } ``` + All field names in the specification are **case sensitive**. This includes all fields that are used as keys in a map, except where explicitly noted that keys are **case insensitive**. @@ -152,22 +159,22 @@ Types that are not accompanied by a `format` property follow the type definition The formats defined by the OAS are: -[`type`](#data-types) | [`format`](#dataTypeFormat) | Comments ------- | -------- | -------- -`integer` | `int32` | signed 32 bits -`integer` | `int64` | signed 64 bits (a.k.a long) -`number` | `float` | | -`number` | `double` | | -`string` | | | -`string` | `byte` | base64 encoded characters -`string` | `binary` | any sequence of octets -`boolean` | | | -`string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -`string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -`string` | `password` | A hint to UIs to obscure input. - +| [`type`](#data-types) | [`format`](#dataTypeFormat) | Comments | +| --------------------- | --------------------------- | ------------------------------------------------------------------------------------------------ | +| `integer` | `int32` | signed 32 bits | +| `integer` | `int64` | signed 64 bits (a.k.a long) | +| `number` | `float` | | +| `number` | `double` | | +| `string` | | | +| `string` | `byte` | base64 encoded characters | +| `string` | `binary` | any sequence of octets | +| `boolean` | | | +| `string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| `string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| `string` | `password` | A hint to UIs to obscure input. | ### Rich Text Formatting + Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting. Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by [CommonMark 0.27](http://spec.commonmark.org/0.27/). Tooling MAY choose to ignore some CommonMark features to address security concerns. @@ -188,16 +195,16 @@ This is the root document object of the [OpenAPI document](#openapi-document). ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string. -info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. -servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. -paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. -components | [Components Object](#components-object) | An element to hold various schemas for the specification. -security | [[Security Requirement Object](#security-requirement-object)] | 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. -tags | [[Tag Object](#tag-object)] | 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](#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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API [`info.version`](#infoVersion) string. | +| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. | +| paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. | +| components | [Components Object](#components-object) | An element to hold various schemas for the specification. | +| security | [[Security Requirement Object](#security-requirement-object)] | 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. | +| tags | [[Tag Object](#tag-object)] | 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -208,15 +215,14 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -title | `string` | **REQUIRED**. The title of the application. -description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. -contact | [Contact Object](#contact-object) | The contact information for the exposed API. -license | [License Object](#license-object) | The license information for the exposed API. -version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). - +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **REQUIRED**. The title of the application. | +| description | `string` | A short description of the application. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -260,11 +266,11 @@ Contact information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | The identifying name of the contact person/organization. -url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. -email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. +| Field Name | Type | Description | +| -------------------------------- | :------: | ------------------------------------------------------------------------------------------------ | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | +| email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -290,10 +296,10 @@ License information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The license name used for the API. -url | `string` | A URL to the license used for the API. MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------ | :------: | ---------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The license name used for the API. | +| url | `string` | A URL to the license used for the API. MUST be in the format of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -317,11 +323,11 @@ An object representing a Server. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. -description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. | +| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -364,12 +370,12 @@ The following shows how multiple servers can be described, for example, at the O ```yaml servers: -- url: https://development.gigantic-server.com/v1 - description: Development server -- url: https://staging.gigantic-server.com/v1 - description: Staging server -- url: https://api.gigantic-server.com/v1 - description: Production server + - url: https://development.gigantic-server.com/v1 + description: Development server + - url: https://staging.gigantic-server.com/v1 + description: Staging server + - url: https://api.gigantic-server.com/v1 + description: Production server ``` The following shows how variables can be used for a server configuration: @@ -386,10 +392,7 @@ The following shows how variables can be used for a server configuration: "description": "this value is assigned by the service provider, in this example `gigantic-server.com`" }, "port": { - "enum": [ - "8443", - "443" - ], + "enum": ["8443", "443"], "default": "8443" }, "basePath": { @@ -403,35 +406,34 @@ The following shows how variables can be used for a server configuration: ```yaml servers: -- url: https://{username}.gigantic-server.com:{port}/{basePath} - description: The production API server - variables: - username: - # note! no enum here means it is an open value - default: demo - description: this value is assigned by the service provider, in this example `gigantic-server.com` - port: - enum: - - '8443' - - '443' - default: '8443' - basePath: - # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` - default: v2 + - url: https://{username}.gigantic-server.com:{port}/{basePath} + description: The production API server + variables: + username: + # note! no enum here means it is an open value + default: demo + description: this value is assigned by the service provider, in this example `gigantic-server.com` + port: + enum: + - "8443" + - "443" + default: "8443" + basePath: + # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` + default: v2 ``` - #### Server Variable Object An object representing a Server Variable for server URL template substitution. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. -default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional. -description | `string` | An optional description for the server variable. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. +| Field Name | Type | Description | +| --------------------------------------------------- | :--------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. | +| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -440,20 +442,19 @@ This object MAY be extended with [Specification Extensions](#specification-exten Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. - ##### Fixed Fields -Field Name | Type | Description ----|:---|--- - schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). - responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). - parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). - examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). - requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). - headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). - securitySchemes| Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). - links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). - callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). +| Field Name | Type | Description | +| -------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). | +| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | +| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | +| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | +| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | +| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -627,7 +628,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GeneralError' + $ref: "#/components/schemas/GeneralError" securitySchemes: api_key: type: apiKey @@ -643,17 +644,16 @@ components: read:pets: read your pets ``` - #### Paths Object Holds the relative paths to the individual endpoints and their operations. -The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#security-filtering). +The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#security-filtering). ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -/{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. +| Field Pattern | Type | Description | +| ------------------------------- | :-----------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a slash. The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -688,7 +688,7 @@ The following may lead to ambiguous resolution: "get": { "description": "Returns all pets from the system that the user has access to", "responses": { - "200": { + "200": { "description": "A list of pets.", "content": { "application/json": { @@ -712,14 +712,14 @@ The following may lead to ambiguous resolution: get: description: Returns all pets from the system that the user has access to responses: - '200': + "200": description: A list of pets. content: application/json: schema: type: array items: - $ref: '#/components/schemas/pet' + $ref: "#/components/schemas/pet" ``` #### Path Item Object @@ -730,22 +730,21 @@ The path itself is still exposed to the documentation viewer but they will not k ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is *undefined*. -summary| `string` | An optional, string summary, intended to apply to all operations in this path. -description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -get | [Operation Object](#operation-object) | A definition of a GET operation on this path. -put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. -post | [Operation Object](#operation-object) | A definition of a POST operation on this path. -delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. -options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. -head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. -patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. -trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. -servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). - +| Field Name | Type | Description | +| --------------------------------------------- | :------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). If there are conflicts between the referenced definition and this Path Item's definition, the behavior is _undefined_. | +| summary | `string` | An optional, string summary, intended to apply to all operations in this path. | +| description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | +| servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -807,30 +806,30 @@ get: summary: Find pets by ID operationId: getPetsById responses: - '200': + "200": description: pet response content: - '*/*' : + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: - 'text/html': + "text/html": schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" parameters: -- name: id - in: path - description: ID of pet to use - required: true - schema: - type: array - style: simple - items: - type: string + - name: id + in: path + description: ID of pet to use + required: true + schema: + type: array + style: simple + items: + type: string ``` #### Operation Object @@ -839,20 +838,20 @@ Describes a single API operation on a path. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. -summary | `string` | A short summary of what the operation does. -description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. -operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). -requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. -responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. -callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#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. -deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. -security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. -servers | [[Server Object](#server-object)] | 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. +| Field Name | Type | Description | +| ------------------------------------------------ | :-----------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. | +| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | +| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. | +| responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#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. | +| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. | +| servers | [[Server Object](#server-object)] | 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -860,9 +859,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "tags": [ - "pet" - ], + "tags": ["pet"], "summary": "Updates a pet in the store with form data", "operationId": "updatePetWithForm", "parameters": [ @@ -881,17 +878,17 @@ This object MAY be extended with [Specification Extensions](#specification-exten "application/x-www-form-urlencoded": { "schema": { "type": "object", - "properties": { - "name": { - "description": "Updated name of the pet", - "type": "string" - }, - "status": { - "description": "Updated status of the pet", - "type": "string" - } - }, - "required": ["status"] + "properties": { + "name": { + "description": "Updated name of the pet", + "type": "string" + }, + "status": { + "description": "Updated status of the pet", + "type": "string" + } + }, + "required": ["status"] } } } @@ -914,10 +911,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten }, "security": [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] } @@ -925,57 +919,56 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```yaml tags: -- pet + - pet summary: Updates a pet in the store with form data operationId: updatePetWithForm parameters: -- name: petId - in: path - description: ID of pet that needs to be updated - required: true - schema: - type: string + - name: petId + in: path + description: ID of pet that needs to be updated + required: true + schema: + type: string requestBody: content: - 'application/x-www-form-urlencoded': + "application/x-www-form-urlencoded": schema: - properties: + properties: name: description: Updated name of the pet type: string status: description: Updated status of the pet type: string - required: - - status + required: + - status responses: - '200': + "200": description: Pet updated. content: - 'application/json': {} - 'application/xml': {} - '405': + "application/json": {} + "application/xml": {} + "405": description: Method Not Allowed content: - 'application/json': {} - 'application/xml': {} + "application/json": {} + "application/xml": {} security: -- petstore_auth: - - write:pets - - read:pets + - petstore_auth: + - write:pets + - read:pets ``` - #### External Documentation Object Allows referencing an external resource for extended documentation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A short description of the target documentation. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1000,58 +993,58 @@ Describes a single operation parameter. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). ##### Parameter Locations -There are four possible parameter locations specified by the `in` field: -* path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. -* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. -* cookie - Used to pass a specific cookie value to the API. +There are four possible parameter locations specified by the `in` field: + +- path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +- header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. +- cookie - Used to pass a specific cookie value to the API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
-in | `string` | **REQUIRED**. The location of the parameter. Possible values are "query", "header", "path" or "cookie". -description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is "path", this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. - deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. - allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. + +| Field Name | Type | Description | +| ------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to the associated path segment from the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
| +| in | `string` | **REQUIRED**. The location of the parameter. Possible values are "query", "header", "path" or "cookie". | +| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is "path", this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | +| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. | The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a [`schema`](#parameterSchema) and [`style`](#parameterStyle) can describe the structure and syntax of the parameter. -Field Name | Type | Description ----|:---:|--- -style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. -explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. -schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. -example | Any | Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. +| Field Name | Type | Description | +| -------------------------------------------------- | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. | +| explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. | +| example | Any | Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. A parameter MUST contain either a `schema` property, or a `content` property, but not both. When `example` or `examples` are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the parameter. - -Field Name | Type | Description ----|:---:|--- -content | Map[`string`, [Media Type Object](#media-type-object)] | 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. +| Field Name | Type | Description | +| -------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| content | Map[`string`, [Media Type Object](#media-type-object)] | 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. | ##### Style Values In order to support common ways of serializing simple parameters, a set of `style` values are defined. -`style` | [`type`](#data-types) | `in` | Comments ------------ | ------ | -------- | -------- -matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) -label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) -form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. -simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. -spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. -pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. -deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. - +| `style` | [`type`](#data-types) | `in` | Comments | +| -------------- | ------------------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. | ##### Style Examples @@ -1062,21 +1055,22 @@ Assume a parameter named `color` has one of the following values: array -> ["blue","black","brown"] object -> { "R": 100, "G": 200, "B": 150 } ``` + The following table shows examples of rendering differences for each value. -[`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` ------------ | ------ | -------- | -------- | --------|------- -matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 -matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 -label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 -label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 -form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 -form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 -simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 -simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 -spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 -pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200|G\|150 -deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 +| [`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` | +| -------------------------- | --------- | ------- | ----------- | ----------------------------------- | -------------------------------------- | ------ | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +| simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 | +| spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 | +| pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200 | G\|150 | +| deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1115,6 +1109,7 @@ style: simple ``` A path parameter of a string value: + ```json { "name": "username", @@ -1137,6 +1132,7 @@ schema: ``` An optional query parameter of a string value, allowing multiple values by repeating the query parameter: + ```json { "name": "id", @@ -1168,6 +1164,7 @@ explode: true ``` A free-form query parameter, allowing undefined parameters of a specific type: + ```json { "in": "query", @@ -1176,7 +1173,7 @@ A free-form query parameter, allowing undefined parameters of a specific type: "type": "object", "additionalProperties": { "type": "integer" - }, + } }, "style": "form" } @@ -1202,10 +1199,7 @@ A complex parameter using `content` to define serialization: "application/json": { "schema": { "type": "object", - "required": [ - "lat", - "long" - ], + "required": ["lat", "long"], "properties": { "lat": { "type": "number" @@ -1242,18 +1236,19 @@ content: Describes a single request body. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. +| Field Name | Type | Description | +| ------------------------------------------------ | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ##### Request Body Examples A request body with a referenced model definition. + ```json { "description": "user to add to the system", @@ -1263,36 +1258,36 @@ A request body with a referenced model definition. "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User Example", - "externalValue": "http://foo.bar/examples/user-example.json" - } + "user": { + "summary": "User Example", + "externalValue": "http://foo.bar/examples/user-example.json" } + } }, "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User example in XML", - "externalValue": "http://foo.bar/examples/user-example.xml" - } + "user": { + "summary": "User example in XML", + "externalValue": "http://foo.bar/examples/user-example.xml" } + } }, "text/plain": { "examples": { - "user" : { - "summary": "User example in Plain text", - "externalValue": "http://foo.bar/examples/user-example.txt" + "user": { + "summary": "User example in Plain text", + "externalValue": "http://foo.bar/examples/user-example.txt" } } }, "*/*": { "examples": { - "user" : { - "summary": "User example in other format", - "externalValue": "http://foo.bar/examples/user-example.whatever" + "user": { + "summary": "User example in other format", + "externalValue": "http://foo.bar/examples/user-example.whatever" } } } @@ -1303,33 +1298,34 @@ A request body with a referenced model definition. ```yaml description: user to add to the system content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example - externalValue: 'http://foo.bar/examples/user-example.json' - 'application/xml': + externalValue: "http://foo.bar/examples/user-example.json" + "application/xml": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example in XML - externalValue: 'http://foo.bar/examples/user-example.xml' - 'text/plain': + externalValue: "http://foo.bar/examples/user-example.xml" + "text/plain": examples: user: summary: User example in text plain format - externalValue: 'http://foo.bar/examples/user-example.txt' - '*/*': + externalValue: "http://foo.bar/examples/user-example.txt" + "*/*": examples: user: summary: User example in other format - externalValue: 'http://foo.bar/examples/user-example.whatever' + externalValue: "http://foo.bar/examples/user-example.whatever" ``` A body parameter that is an array of string values: + ```json { "description": "user to add to the system", @@ -1357,17 +1353,18 @@ content: type: string ``` - #### Media Type Object + Each Media Type Object provides schema and examples for the media type identified by its key. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the content of the request, response, or parameter. -example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. -encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. + +| Field Name | Type | Description | +| ---------------------------------------- | :----------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the content of the request, response, or parameter. | +| example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1377,30 +1374,29 @@ This object MAY be extended with [Specification Extensions](#specification-exten { "application/json": { "schema": { - "$ref": "#/components/schemas/Pet" + "$ref": "#/components/schemas/Pet" }, "examples": { - "cat" : { + "cat": { "summary": "An example of a cat", - "value": - { - "name": "Fluffy", - "petType": "Cat", - "color": "White", - "gender": "male", - "breed": "Persian" - } + "value": { + "name": "Fluffy", + "petType": "Cat", + "color": "White", + "gender": "male", + "breed": "Persian" + } }, "dog": { "summary": "An example of a dog with a cat's name", - "value" : { + "value": { "name": "Puma", "petType": "Dog", "color": "Black", "gender": "Female", "breed": "Mixed" }, - "frog": { + "frog": { "$ref": "#/components/examples/frog-example" } } @@ -1473,15 +1469,15 @@ In addition, specific media types MAY be specified: # multiple, specific media types may be specified: requestBody: content: - # a binary file of type png or jpeg - 'image/jpeg': + # a binary file of type png or jpeg + "image/jpeg": schema: type: string format: binary - 'image/png': + "image/png": schema: type: string - format: binary + format: binary ``` To upload multiple files, a `multipart` media type MUST be used: @@ -1498,7 +1494,6 @@ requestBody: items: type: string format: binary - ``` ##### Support for x-www-form-urlencoded Request Bodies @@ -1522,20 +1517,19 @@ requestBody: properties: {} ``` -In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. +In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. When passing complex objects in the `application/x-www-form-urlencoded` content type, the default serialization strategy of such properties is described in the [`Encoding Object`](#encoding-object)'s [`style`](#encodingStyle) property as `form`. ##### Special Considerations for `multipart` Content -It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. +It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. When passing in `multipart` types, boundaries MAY be used to separate sections of the content being transferred — thus, the following default `Content-Type`s are defined for `multipart`: -* If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` -* If the property is complex, or an array of complex values, the default Content-Type is `application/json` -* If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` - +- If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` +- If the property is complex, or an array of complex values, the default Content-Type is `application/json` +- If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` Examples: @@ -1566,23 +1560,24 @@ requestBody: # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example) type: array items: - type: '#/components/schemas/Address' + type: "#/components/schemas/Address" ``` -An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. +An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. #### Encoding Object A single encoding definition applied to a single schema property. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. -style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. + +| Field Name | Type | Description | +| ------------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. | +| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1641,15 +1636,16 @@ The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. + +| Field Name | Type | Description | +| -------------------------------------- | :--------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -[HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. +| Field Pattern | Type | Description | +| ------------------------------------------------------------------ | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1683,31 +1679,33 @@ A 200 response for a successful operation and a default response for others (imp ``` ```yaml -'200': +"200": description: a pet to be returned content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: Unexpected error content: application/json: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` #### Response Object + Describes a single response from an API Operation, including design-time, static `links` to operations based on the response. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. -content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* -links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). + +| Field Name | Type | Description | +| --------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/\* | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1738,7 +1736,7 @@ content: schema: type: array items: - $ref: '#/components/schemas/VeryComplexType' + $ref: "#/components/schemas/VeryComplexType" ``` Response with a string type: @@ -1753,7 +1751,6 @@ Response with a string type: } } } - } ``` @@ -1806,7 +1803,7 @@ content: text/plain: schema: type: string - example: 'whoa!' + example: "whoa!" headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period @@ -1841,9 +1838,10 @@ Each value in the map is a [Path Item Object](#path-item-object) that describes 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. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. + +| Field Pattern | Type | Description | +| --------------------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1877,17 +1875,16 @@ Location: http://example.org/subscription/1 The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. -Expression | Value ----|:--- -$url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning -$method | POST -$request.path.eventType | myevent -$request.query.queryUrl | http://clientdomain.com/stillrunning -$request.header.content-Type | application/json -$request.body#/failedUrl | http://clientdomain.com/failed -$request.body#/successUrls/2 | http://clientdomain.com/medium -$response.header.Location | http://example.org/subscription/1 - +| Expression | Value | +| ---------------------------- | :--------------------------------------------------------------------------------- | +| $url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | http://clientdomain.com/stillrunning | +| $request.header.content-Type | application/json | +| $request.body#/failedUrl | http://clientdomain.com/failed | +| $request.body#/successUrls/2 | http://clientdomain.com/medium | +| $response.header.Location | http://example.org/subscription/1 | ##### Callback Object Example @@ -1895,34 +1892,34 @@ The following example shows a callback to the URL specified by the `id` and `ema ```yaml myWebhook: - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + "http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}": post: requestBody: description: Callback payload content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: webhook successfully processed and no retries will be performed ``` - #### Example Object ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -summary | `string` | Short description for the example. -description | `string` | Long description for the example. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. -externalValue | `string` | A 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. + +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | Short description for the example. | +| description | `string` | Long description for the example. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | +| externalValue | `string` | A 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). In all cases, the example value is expected to be compatible with the type schema -of its associated value. Tooling implementations MAY choose to +of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible. ##### Example Object Examples @@ -1944,58 +1941,57 @@ In a request body: ```yaml requestBody: content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" examples: foo: summary: A foo example - value: {"foo": "bar"} + value: { "foo": "bar" } bar: summary: A bar example - value: {"bar": "baz"} - 'application/xml': + value: { "bar": "baz" } + "application/xml": examples: xmlExample: summary: This is an example in XML - externalValue: 'http://example.org/examples/address-example.xml' - 'text/plain': + externalValue: "http://example.org/examples/address-example.xml" + "text/plain": examples: textExample: summary: This is a text example - externalValue: 'http://foo.bar/examples/address-example.txt' + externalValue: "http://foo.bar/examples/address-example.txt" ``` In a parameter: ```yaml parameters: - - name: 'zipCode' - in: 'query' + - name: "zipCode" + in: "query" schema: - type: 'string' - format: 'zip-code' + type: "string" + format: "zip-code" examples: zip-example: - $ref: '#/components/examples/zip-example' + $ref: "#/components/examples/zip-example" ``` In a response: ```yaml responses: - '200': + "200": description: your car appointment has been booked content: application/json: schema: - $ref: '#/components/schemas/SuccessResponse' + $ref: "#/components/schemas/SuccessResponse" examples: confirmation-success: - $ref: '#/components/examples/confirmation-success' + $ref: "#/components/examples/confirmation-success" ``` - #### Link Object The `Link object` represents a possible design-time link for a response. @@ -2003,18 +1999,18 @@ The presence of a link does not guarantee the caller's ability to successfully i Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response. -For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. +For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -operationRef | `string` | A relative or absolute reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. -operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. -parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). -requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. -description | `string` | A description of the link. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -server | [Server Object](#server-object) | A server object to be used by the target operation. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| operationRef | `string` | A relative or absolute reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). | +| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#server-object) | A server object to be used by the target operation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2031,15 +2027,15 @@ Computing a link from a request operation where the `$request.path.id` is used t paths: /users/{id}: parameters: - - name: id - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: id + in: path + required: true + description: the user identifier, as userId + schema: + type: string get: responses: - '200': + "200": description: the user being returned content: application/json: @@ -2059,17 +2055,17 @@ paths: # the path item of the linked operation /users/{userid}/address: parameters: - - name: userid - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: userid + in: path + required: true + description: the user identifier, as userId + schema: + type: string # linked operation get: operationId: getUserAddress responses: - '200': + "200": description: the user's address ``` @@ -2090,7 +2086,6 @@ Clients follow all links at their discretion. Neither permissions, nor the capability to make a successful call to that link, is guaranteed solely by the existence of a relationship. - ##### OperationRef Examples As references to `operationId` MAY NOT be possible (the `operationId` is an optional @@ -2100,7 +2095,7 @@ value), references MAY also be made through a relative `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: '#/paths/~12.0~1repositories~1{username}/get' + operationRef: "#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2111,7 +2106,7 @@ or an absolute `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: 'https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get' + operationRef: "https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2119,7 +2114,6 @@ links: Note that in the use of `operationRef`, the _escaped forward-slash_ is necessary when using JSON references. - ##### Runtime Expressions Runtime expressions allow defining values based on information that will only be available within the HTTP message in an actual API call. @@ -2129,12 +2123,12 @@ The runtime expression is defined by the following [ABNF](https://tools.ietf.org ``` expression = ( "$url" | "$method" | "$statusCode" | "$request." source | "$response." source ) - source = ( header-reference | query-reference | path-reference | body-reference ) + source = ( header-reference | query-reference | path-reference | body-reference ) header-reference = "header." token - query-reference = "query." name + query-reference = "query." name path-reference = "path." name body-reference = "body" ["#" fragment] - fragment = a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901) + fragment = a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901) name = *( char ) char = as per RFC [7159](https://tools.ietf.org/html/rfc7159#section-7) token = as per RFC [7230](https://tools.ietf.org/html/rfc7230#section-3.2.6) @@ -2146,15 +2140,15 @@ The table below provides examples of runtime expressions and examples of their u ##### Examples -Source Location | example expression | notes ----|:---|:---| -HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. -Requested media type | `$request.header.accept` | -Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. -Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. -Request URL | `$url` | -Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. -Response header | `$response.header.Server` | Single header values only are available +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | Runtime expressions preserve the type of the referenced value. Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. @@ -2192,11 +2186,12 @@ Adds metadata to a single tag that is used by the [Operation Object](#operation- It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the tag. -description | `string` | A short description for the tag. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. + +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the tag. | +| description | `string` | A short description for the tag. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2204,8 +2199,8 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "name": "pet", - "description": "Pets operations" + "name": "pet", + "description": "Pets operations" } ``` @@ -2214,7 +2209,6 @@ name: pet description: Pets operations ``` - #### Reference Object A simple object to allow referencing other components in the specification, internally and externally. @@ -2224,9 +2218,10 @@ The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/ For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | **REQUIRED**. The reference string. + +| Field Name | Type | Description | +| ------------------------------- | :------: | ----------------------------------- | +| $ref | `string` | **REQUIRED**. The reference string. | This object cannot be extended with additional properties and any properties added SHALL be ignored. @@ -2234,15 +2229,16 @@ This object cannot be extended with additional properties and any properties add ```json { - "$ref": "#/components/schemas/Pet" + "$ref": "#/components/schemas/Pet" } ``` ```yaml -$ref: '#/components/schemas/Pet' +$ref: "#/components/schemas/Pet" ``` ##### Relative Schema Document Example + ```json { "$ref": "Pet.json" @@ -2254,6 +2250,7 @@ $ref: Pet.yaml ``` ##### Relative Documents With Embedded Schema Example + ```json { "$ref": "definitions.json#/Pet" @@ -2295,6 +2292,7 @@ The following properties are taken directly from the JSON Schema definition and - enum The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification. + - type - Value MUST be a string. Multiple types via an array are not supported. - allOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. - oneOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. @@ -2314,32 +2312,34 @@ Additional properties defined by the JSON Schema specification that are not ment Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation: ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`. -discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. -readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". 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`. -writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". 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`. -xml | [XML Object](#xml-object) | 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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. -example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. - deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. + +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| nullable | `boolean` | Allows sending a `null` value for the defined schema. Default value is `false`. | +| discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. | +| readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". 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`. | +| writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". 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`. | +| xml | [XML Object](#xml-object) | 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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. | +| deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ###### Composition and Inheritance (Polymorphism) The OpenAPI Specification allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition. -`allOf` takes an array of object definitions that are validated *independently* but together compose a single object. +`allOf` takes an array of object definitions that are validated _independently_ but together compose a single object. While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, the OpenAPI Specification adds the `discriminator` field. When used, the `discriminator` will be the name of the property that decides which schema definition validates the structure of the model. As such, the `discriminator` field MUST be a required field. There are two ways to define the value of a discriminator for an inheriting instance. + - Use the schema name. - Override the schema name by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. -As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism. + As such, inline schema definitions, which do not have a given id, _cannot_ be used in polymorphism. ###### XML Modeling @@ -2367,9 +2367,7 @@ format: email ```json { "type": "object", - "required": [ - "name" - ], + "required": ["name"], "properties": { "name": { "type": "string" @@ -2389,12 +2387,12 @@ format: email ```yaml type: object required: -- name + - name properties: name: type: string address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" age: type: integer format: int32 @@ -2434,7 +2432,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/components/schemas/ComplexModel' + $ref: "#/components/schemas/ComplexModel" ``` ###### Model with Example @@ -2451,9 +2449,7 @@ additionalProperties: "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "example": { "name": "Puma", "id": 1 @@ -2470,7 +2466,7 @@ properties: name: type: string required: -- name + - name example: name: Puma id: 1 @@ -2484,10 +2480,7 @@ example: "schemas": { "ErrorModel": { "type": "object", - "required": [ - "message", - "code" - ], + "required": ["message", "code"], "properties": { "message": { "type": "string" @@ -2506,9 +2499,7 @@ example: }, { "type": "object", - "required": [ - "rootCause" - ], + "required": ["rootCause"], "properties": { "rootCause": { "type": "string" @@ -2528,8 +2519,8 @@ components: ErrorModel: type: object required: - - message - - code + - message + - code properties: message: type: string @@ -2539,13 +2530,13 @@ components: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/components/schemas/ErrorModel' - - type: object - required: - - rootCause - properties: - rootCause: - type: string + - $ref: "#/components/schemas/ErrorModel" + - type: object + required: + - rootCause + properties: + rootCause: + type: string ``` ###### Models with Polymorphism Support @@ -2567,10 +2558,7 @@ components: "type": "string" } }, - "required": [ - "name", - "petType" - ] + "required": ["name", "petType"] }, "Cat": { "description": "A representation of a cat. Note that `Cat` will be used as the discriminator value.", @@ -2585,17 +2573,10 @@ components: "type": "string", "description": "The measured skill for hunting", "default": "lazy", - "enum": [ - "clueless", - "lazy", - "adventurous", - "aggressive" - ] + "enum": ["clueless", "lazy", "adventurous", "aggressive"] } }, - "required": [ - "huntingSkill" - ] + "required": ["huntingSkill"] } ] }, @@ -2616,9 +2597,7 @@ components: "minimum": 0 } }, - "required": [ - "packSize" - ] + "required": ["packSize"] } ] } @@ -2640,51 +2619,52 @@ components: petType: type: string required: - - name - - petType - Cat: ## "Cat" will be used as the discriminator value + - name + - petType + Cat: ## "Cat" will be used as the discriminator value description: A representation of a cat allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - huntingSkill: - type: string - description: The measured skill for hunting - enum: - - clueless - - lazy - - adventurous - - aggressive - required: - - huntingSkill - Dog: ## "Dog" will be used as the discriminator value + - $ref: "#/components/schemas/Pet" + - type: object + properties: + huntingSkill: + type: string + description: The measured skill for hunting + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill + Dog: ## "Dog" will be used as the discriminator value description: A representation of a dog allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - packSize: - type: integer - format: int32 - description: the size of the pack the dog is from - default: 0 - minimum: 0 - required: - - packSize + - $ref: "#/components/schemas/Pet" + - type: object + properties: + packSize: + type: integer + format: int32 + description: the size of the pack the dog is from + default: 0 + minimum: 0 + required: + - packSize ``` #### Discriminator Object -When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. +When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. When using the discriminator, _inline_ schemas will not be considered. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. - mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. + +| Field Name | Type | Description | +| ------------------------------------------- | :---------------------: | --------------------------------------------------------------------------------------------- | +| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. | +| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. | The discriminator object is legal only when using one of the composite keywords `oneOf`, `anyOf`, `allOf`. @@ -2693,25 +2673,24 @@ In OAS 3.0, a response payload MAY be described to be exactly one of any number ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" ``` -which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: - +which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" discriminator: propertyName: petType ``` -The expectation now is that a property with name `petType` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: +The expectation now is that a property with name `petType` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: ```json { @@ -2727,22 +2706,22 @@ In scenarios where the value of the discriminator field does not match the schem ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' - - $ref: 'https://gigantic-server.com/schemas/Monster/schema.json' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" + - $ref: "https://gigantic-server.com/schemas/Monster/schema.json" discriminator: propertyName: petType mapping: - dog: '#/components/schemas/Dog' - monster: 'https://gigantic-server.com/schemas/Monster/schema.json' + dog: "#/components/schemas/Dog" + monster: "https://gigantic-server.com/schemas/Monster/schema.json" ``` -Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. +Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. When used in conjunction with the `anyOf` construct, the use of the discriminator can avoid ambiguity where multiple schemas may satisfy a single payload. -In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. +In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. For example: @@ -2752,7 +2731,7 @@ components: Pet: type: object required: - - petType + - petType properties: petType: type: string @@ -2762,28 +2741,28 @@ components: dog: Dog Cat: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Cat` - properties: - name: - type: string + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Cat` + properties: + name: + type: string Dog: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Dog` - properties: - bark: - type: string + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Dog` + properties: + bark: + type: string Lizard: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Lizard` - properties: - lovesRocks: - type: boolean + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Lizard` + properties: + lovesRocks: + type: boolean ``` a payload like this: @@ -2795,7 +2774,7 @@ a payload like this: } ``` -will indicate that the `Cat` schema be used. Likewise this schema: +will indicate that the `Cat` schema be used. Likewise this schema: ```json { @@ -2806,22 +2785,22 @@ will indicate that the `Cat` schema be used. Likewise this schema: will map to `Dog` because of the definition in the `mappings` element. - #### XML Object A metadata object that allows for more fine-tuned XML model definitions. -When using arrays, XML element names are *not* inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. +When using arrays, XML element names are _not_ inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. See examples for expected behavior. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. -namespace | `string` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. -prefix | `string` | The prefix to be used for the [name](#xmlName). -attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. -wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). + +| Field Name | Type | Description | +| ------------------------------------ | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. | +| prefix | `string` | The prefix to be used for the [name](#xmlName). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2835,9 +2814,9 @@ Basic string property: ```json { - "animals": { - "type": "string" - } + "animals": { + "type": "string" + } } ``` @@ -2854,12 +2833,12 @@ Basic string array property ([`wrapped`](#xmlWrapped) is `false` by default): ```json { - "animals": { - "type": "array", - "items": { - "type": "string" - } + "animals": { + "type": "array", + "items": { + "type": "string" } + } } ``` @@ -2900,7 +2879,6 @@ animals: ... ``` - ###### XML Attribute, Prefix and Namespace In this example, a full model definition is shown. @@ -3166,16 +3144,17 @@ Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06). ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. -description | `string` | Any | A short description for security scheme. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. -name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. -in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. -scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). -bearerFormat | `string` | `http` (`"bearer"`) | 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. -flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. -openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. + +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------- | :---------------------------------------: | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A short description for security scheme. [CommonMark syntax](http://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). | +| bearerFormat | `string` | `http` (`"bearer"`) | 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. | +| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3217,7 +3196,7 @@ in: header { "type": "http", "scheme": "bearer", - "bearerFormat": "JWT", + "bearerFormat": "JWT" } ``` @@ -3259,12 +3238,13 @@ flows: Allows configuration of the supported OAuth Flows. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -implicit| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow -password| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow -clientCredentials| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. -authorizationCode| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. + +| Field Name | Type | Description | +| ----------------------------------------------------------- | :-------------------------------------: | ---------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | +| clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3273,12 +3253,13 @@ This object MAY be extended with [Specification Extensions](#specification-exten Configuration details for a supported OAuth Flow ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. -tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. -refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. -scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. + +| Field Name | Type | Applies To | Description | +| -------------------------------------------------------- | :---------------------: | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3323,7 +3304,6 @@ flows: read:pets: read your pets ``` - #### Security Requirement Object Lists the required security schemes to execute this operation. @@ -3336,9 +3316,9 @@ When a list of Security Requirement Objects is defined on the [OpenAPI Object](# ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. +| Field Pattern | Type | Description | +| --------------------------------------------- | :--------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty. | ##### Security Requirement Object Examples @@ -3358,17 +3338,14 @@ api_key: [] ```json { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ``` ```yaml petstore_auth: -- write:pets -- read:pets + - write:pets + - read:pets ``` ### Specification Extensions @@ -3377,9 +3354,9 @@ While the OpenAPI Specification tries to accommodate most use cases, additional The extensions properties are implemented as patterned fields that are always prefixed by `"x-"`. -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. +| Field Pattern | Type | Description | +| -------------------------------- | :--: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. | The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). @@ -3397,16 +3374,16 @@ Two examples of this: ## Appendix A: Revision History -Version | Date | Notes ---- | --- | --- -3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 -3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 -3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 -3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification -3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification -3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification -2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative -2.0 | 2014-09-08 | Release of Swagger 2.0 -1.2 | 2014-03-14 | Initial release of the formal document. -1.1 | 2012-08-22 | Release of Swagger 1.1 -1.0 | 2011-08-10 | First release of the Swagger Specification +| Version | Date | Notes | +| --------- | ---------- | -------------------------------------------------- | +| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | +| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the Open API Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | diff --git a/3.0/3.0.3.md b/3.0/3.0.3.md index 13a96ea..34b9b19 100644 --- a/3.0/3.0.3.md +++ b/3.0/3.0.3.md @@ -13,73 +13,77 @@ The OpenAPI Specification (OAS) defines a standard, language-agnostic interface An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. ## Table of Contents + - [Definitions](#definitions) - - [OpenAPI Document](#openapi-document) - - [Path Templating](#path-templating) - - [Media Types](#media-types) - - [HTTP Status Codes](#http-status-codes) + - [OpenAPI Document](#openapi-document) + - [Path Templating](#path-templating) + - [Media Types](#media-types) + - [HTTP Status Codes](#http-status-codes) - [Specification](#specification) - - [Versions](#versions) - - [Format](#format) - - [Document Structure](#document-structure) - - [Data Types](#data-types) - - [Rich Text Formatting](#rich-text-formatting) - - [Relative References In URLs](#relative-references-in-urls) - - [Schema](#schema) - - [OpenAPI Object](#openapi-object) - - [Info Object](#info-object) - - [Contact Object](#contact-object) - - [License Object](#license-object) - - [Server Object](#server-object) - - [Server Variable Object](#server-variable-object) - - [Components Object](#components-object) - - [Paths Object](#paths-object) - - [Path Item Object](#path-item-object) - - [Operation Object](#operation-object) - - [External Documentation Object](#external-documentation-object) - - [Parameter Object](#parameter-object) - - [Request Body Object](#request-body-object) - - [Media Type Object](#media-type-object) - - [Encoding Object](#encoding-object) - - [Responses Object](#responses-object) - - [Response Object](#response-object) - - [Callback Object](#callback-object) - - [Example Object](#example-object) - - [Link Object](#link-object) - - [Header Object](#header-object) - - [Tag Object](#tag-object) - - [Reference Object](#reference-object) - - [Schema Object](#schema-object) - - [Discriminator Object](#discriminator-object) - - [XML Object](#xml-object) - - [Security Scheme Object](#security-scheme-object) - - [OAuth Flows Object](#oauth-flows-object) - - [OAuth Flow Object](#oauth-flow-object) - - [Security Requirement Object](#security-requirement-object) - - [Specification Extensions](#specification-extensions) - - [Security Filtering](#security-filtering) + - [Versions](#versions) + - [Format](#format) + - [Document Structure](#document-structure) + - [Data Types](#data-types) + - [Rich Text Formatting](#rich-text-formatting) + - [Relative References In URLs](#relative-references-in-urls) + - [Schema](#schema) + - [OpenAPI Object](#openapi-object) + - [Info Object](#info-object) + - [Contact Object](#contact-object) + - [License Object](#license-object) + - [Server Object](#server-object) + - [Server Variable Object](#server-variable-object) + - [Components Object](#components-object) + - [Paths Object](#paths-object) + - [Path Item Object](#path-item-object) + - [Operation Object](#operation-object) + - [External Documentation Object](#external-documentation-object) + - [Parameter Object](#parameter-object) + - [Request Body Object](#request-body-object) + - [Media Type Object](#media-type-object) + - [Encoding Object](#encoding-object) + - [Responses Object](#responses-object) + - [Response Object](#response-object) + - [Callback Object](#callback-object) + - [Example Object](#example-object) + - [Link Object](#link-object) + - [Header Object](#header-object) + - [Tag Object](#tag-object) + - [Reference Object](#reference-object) + - [Schema Object](#schema-object) + - [Discriminator Object](#discriminator-object) + - [XML Object](#xml-object) + - [Security Scheme Object](#security-scheme-object) + - [OAuth Flows Object](#oauth-flows-object) + - [OAuth Flow Object](#oauth-flow-object) + - [Security Requirement Object](#security-requirement-object) + - [Specification Extensions](#specification-extensions) + - [Security Filtering](#security-filtering) - [Appendix A: Revision History](#appendix-a-revision-history) - ## Definitions ##### OpenAPI Document + A document (or set of documents) that defines or describes an API. An OpenAPI definition uses and conforms to the OpenAPI Specification. ##### Path Templating + Path templating refers to the usage of template expressions, delimited by curly braces ({}), to mark a section of a URL path as replaceable using path parameters. Each template expression in the path MUST correspond to a path parameter that is included in the [Path Item](#path-item-object) itself and/or in each of the Path Item's [Operations](#operation-object). ##### Media Types + Media type definitions are spread across several resources. The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838). Some examples of possible media type definitions: + ``` text/plain; charset=utf-8 application/json @@ -92,7 +96,9 @@ Some examples of possible media type definitions: application/vnd.github.v3.diff application/vnd.github.v3.patch ``` + ##### HTTP Status Codes + The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are defined by [RFC7231](https://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). @@ -102,7 +108,7 @@ The available status codes are defined by [RFC7231](https://tools.ietf.org/html/ The OpenAPI Specification is versioned using [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) (semver) and follows the semver specification. -The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, *`.patch`* versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. +The `major`.`minor` portion of the semver (for example `3.0`) SHALL designate the OAS feature set. Typically, _`.patch`_ versions address errors in this document, not the feature set. Tooling which supports OAS 3.0 SHOULD be compatible with all OAS 3.0.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.0.0` and `3.0.1` for example. Each new minor version of the OpenAPI Specification SHALL allow any OpenAPI document that is valid against any previous minor version of the Specification, within the same major version, to be updated to the new Specification version with equivalent semantics. Such an update MUST only require changing the `openapi` property to the new minor version. @@ -118,9 +124,10 @@ For example, if a field has an array value, the JSON array representation will b ```json { - "field": [ 1, 2, 3 ] + "field": [1, 2, 3] } ``` + All field names in the specification are **case sensitive**. This includes all fields that are used as keys in a map, except where explicitly noted that keys are **case insensitive**. @@ -156,22 +163,22 @@ Types that are not accompanied by a `format` property follow the type definition The formats defined by the OAS are: -[`type`](#data-types) | [`format`](#dataTypeFormat) | Comments ------- | -------- | -------- -`integer` | `int32` | signed 32 bits -`integer` | `int64` | signed 64 bits (a.k.a long) -`number` | `float` | | -`number` | `double` | | -`string` | | | -`string` | `byte` | base64 encoded characters -`string` | `binary` | any sequence of octets -`boolean` | | | -`string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -`string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) -`string` | `password` | A hint to UIs to obscure input. - +| [`type`](#data-types) | [`format`](#dataTypeFormat) | Comments | +| --------------------- | --------------------------- | ------------------------------------------------------------------------------------------------ | +| `integer` | `int32` | signed 32 bits | +| `integer` | `int64` | signed 64 bits (a.k.a long) | +| `number` | `float` | | +| `number` | `double` | | +| `string` | | | +| `string` | `byte` | base64 encoded characters | +| `string` | `binary` | any sequence of octets | +| `boolean` | | | +| `string` | `date` | As defined by `full-date` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| `string` | `date-time` | As defined by `date-time` - [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) | +| `string` | `password` | A hint to UIs to obscure input. | ### Rich Text Formatting + Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting. Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by [CommonMark 0.27](https://spec.commonmark.org/0.27/). Tooling MAY choose to ignore some CommonMark features to address security concerns. @@ -192,16 +199,16 @@ This is the root document object of the [OpenAPI document](#openapi-document). ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string. -info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. -servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. -paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. -components | [Components Object](#components-object) | An element to hold various schemas for the specification. -security | [[Security Requirement Object](#security-requirement-object)] | 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. -tags | [[Tag Object](#tag-object)] | 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](#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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html) of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is _not_ related to the API [`info.version`](#infoVersion) string. | +| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. | +| paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. | +| components | [Components Object](#components-object) | An element to hold various schemas for the specification. | +| security | [[Security Requirement Object](#security-requirement-object)] | 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. | +| tags | [[Tag Object](#tag-object)] | 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -212,15 +219,14 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -title | `string` | **REQUIRED**. The title of the API. -description | `string` | A short description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. -contact | [Contact Object](#contact-object) | The contact information for the exposed API. -license | [License Object](#license-object) | The license information for the exposed API. -version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). - +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **REQUIRED**. The title of the API. | +| description | `string` | A short description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | A URL to the Terms of Service for the API. MUST be in the format of a URL. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -264,11 +270,11 @@ Contact information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | The identifying name of the contact person/organization. -url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. -email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. +| Field Name | Type | Description | +| -------------------------------- | :------: | ------------------------------------------------------------------------------------------------ | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URL pointing to the contact information. MUST be in the format of a URL. | +| email | `string` | The email address of the contact person/organization. MUST be in the format of an email address. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -294,10 +300,10 @@ License information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The license name used for the API. -url | `string` | A URL to the license used for the API. MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------ | :------: | ---------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The license name used for the API. | +| url | `string` | A URL to the license used for the API. MUST be in the format of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -321,11 +327,11 @@ An object representing a Server. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. -description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. | +| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -368,12 +374,12 @@ The following shows how multiple servers can be described, for example, at the O ```yaml servers: -- url: https://development.gigantic-server.com/v1 - description: Development server -- url: https://staging.gigantic-server.com/v1 - description: Staging server -- url: https://api.gigantic-server.com/v1 - description: Production server + - url: https://development.gigantic-server.com/v1 + description: Development server + - url: https://staging.gigantic-server.com/v1 + description: Staging server + - url: https://api.gigantic-server.com/v1 + description: Production server ``` The following shows how variables can be used for a server configuration: @@ -390,10 +396,7 @@ The following shows how variables can be used for a server configuration: "description": "this value is assigned by the service provider, in this example `gigantic-server.com`" }, "port": { - "enum": [ - "8443", - "443" - ], + "enum": ["8443", "443"], "default": "8443" }, "basePath": { @@ -407,35 +410,34 @@ The following shows how variables can be used for a server configuration: ```yaml servers: -- url: https://{username}.gigantic-server.com:{port}/{basePath} - description: The production API server - variables: - username: - # note! no enum here means it is an open value - default: demo - description: this value is assigned by the service provider, in this example `gigantic-server.com` - port: - enum: - - '8443' - - '443' - default: '8443' - basePath: - # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` - default: v2 + - url: https://{username}.gigantic-server.com:{port}/{basePath} + description: The production API server + variables: + username: + # note! no enum here means it is an open value + default: demo + description: this value is assigned by the service provider, in this example `gigantic-server.com` + port: + enum: + - "8443" + - "443" + default: "8443" + basePath: + # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` + default: v2 ``` - #### Server Variable Object An object representing a Server Variable for server URL template substitution. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty. -default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional. If the [`enum`](#serverVariableEnum) is defined, the value SHOULD exist in the enum's values. -description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. +| Field Name | Type | Description | +| --------------------------------------------------- | :--------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty. | +| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional. If the [`enum`](#serverVariableEnum) is defined, the value SHOULD exist in the enum's values. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -444,20 +446,19 @@ This object MAY be extended with [Specification Extensions](#specification-exten Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. - ##### Fixed Fields -Field Name | Type | Description ----|:---|--- - schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). - responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). - parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). - examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). - requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). - headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). - securitySchemes| Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). - links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). - callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). +| Field Name | Type | Description | +| -------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). | +| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | +| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | +| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | +| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | +| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -631,7 +632,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GeneralError' + $ref: "#/components/schemas/GeneralError" securitySchemes: api_key: type: apiKey @@ -647,17 +648,16 @@ components: read:pets: read your pets ``` - #### Paths Object Holds the relative paths to the individual endpoints and their operations. -The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#security-filtering). +The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [ACL constraints](#security-filtering). ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -/{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. +| Field Pattern | Type | Description | +| ------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -692,7 +692,7 @@ The following may lead to ambiguous resolution: "get": { "description": "Returns all pets from the system that the user has access to", "responses": { - "200": { + "200": { "description": "A list of pets.", "content": { "application/json": { @@ -716,14 +716,14 @@ The following may lead to ambiguous resolution: get: description: Returns all pets from the system that the user has access to responses: - '200': + "200": description: A list of pets. content: application/json: schema: type: array items: - $ref: '#/components/schemas/pet' + $ref: "#/components/schemas/pet" ``` #### Path Item Object @@ -734,22 +734,21 @@ The path itself is still exposed to the documentation viewer but they will not k ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. -summary| `string` | An optional, string summary, intended to apply to all operations in this path. -description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -get | [Operation Object](#operation-object) | A definition of a GET operation on this path. -put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. -post | [Operation Object](#operation-object) | A definition of a POST operation on this path. -delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. -options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. -head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. -patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. -trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. -servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). - +| Field Name | Type | Description | +| --------------------------------------------- | :------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for an external definition of this path item. The referenced structure MUST be in the format of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. | +| summary | `string` | An optional, string summary, intended to apply to all operations in this path. | +| description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | +| servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -811,30 +810,30 @@ get: summary: Find pets by ID operationId: getPetsById responses: - '200': + "200": description: pet response content: - '*/*' : + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: - 'text/html': + "text/html": schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" parameters: -- name: id - in: path - description: ID of pet to use - required: true - schema: - type: array - items: - type: string - style: simple + - name: id + in: path + description: ID of pet to use + required: true + schema: + type: array + items: + type: string + style: simple ``` #### Operation Object @@ -843,20 +842,20 @@ Describes a single API operation on a path. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. -summary | `string` | A short summary of what the operation does. -description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. -operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). -requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. -responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. -callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. -deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. -security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. -servers | [[Server Object](#server-object)] | 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. +| Field Name | Type | Description | +| ------------------------------------------------ | :-----------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. | +| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | +| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, `requestBody` SHALL be ignored by consumers. | +| responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. | +| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. | +| servers | [[Server Object](#server-object)] | 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -864,9 +863,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "tags": [ - "pet" - ], + "tags": ["pet"], "summary": "Updates a pet in the store with form data", "operationId": "updatePetWithForm", "parameters": [ @@ -918,10 +915,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten }, "security": [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] } @@ -929,57 +923,56 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```yaml tags: -- pet + - pet summary: Updates a pet in the store with form data operationId: updatePetWithForm parameters: -- name: petId - in: path - description: ID of pet that needs to be updated - required: true - schema: - type: string + - name: petId + in: path + description: ID of pet that needs to be updated + required: true + schema: + type: string requestBody: content: - 'application/x-www-form-urlencoded': + "application/x-www-form-urlencoded": schema: - properties: + properties: name: description: Updated name of the pet type: string status: description: Updated status of the pet type: string - required: - - status + required: + - status responses: - '200': + "200": description: Pet updated. content: - 'application/json': {} - 'application/xml': {} - '405': + "application/json": {} + "application/xml": {} + "405": description: Method Not Allowed content: - 'application/json': {} - 'application/xml': {} + "application/json": {} + "application/xml": {} security: -- petstore_auth: - - write:pets - - read:pets + - petstore_auth: + - write:pets + - read:pets ``` - #### External Documentation Object Allows referencing an external resource for extended documentation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A short description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | -------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A short description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| url | `string` | **REQUIRED**. The URL for the target documentation. Value MUST be in the format of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1004,58 +997,58 @@ Describes a single operation parameter. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). ##### Parameter Locations -There are four possible parameter locations specified by the `in` field: -* path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. -* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. -* cookie - Used to pass a specific cookie value to the API. +There are four possible parameter locations specified by the `in` field: + +- path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +- header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. +- cookie - Used to pass a specific cookie value to the API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
-in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. -description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is `"path"`, this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. - deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. - allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. + +| Field Name | Type | Description | +| ------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
| +| in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. | +| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is `"path"`, this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | +| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. | The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a [`schema`](#parameterSchema) and [`style`](#parameterStyle) can describe the structure and syntax of the parameter. -Field Name | Type | Description ----|:---:|--- -style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. -explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. -schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. -example | Any | Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` that contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema. +| Field Name | Type | Description | +| -------------------------------------------------- | :----------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. | +| explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. | +| example | Any | Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` that contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema. | For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. A parameter MUST contain either a `schema` property, or a `content` property, but not both. When `example` or `examples` are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the parameter. - -Field Name | Type | Description ----|:---:|--- -content | Map[`string`, [Media Type Object](#media-type-object)] | 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. +| Field Name | Type | Description | +| -------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| content | Map[`string`, [Media Type Object](#media-type-object)] | 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. | ##### Style Values In order to support common ways of serializing simple parameters, a set of `style` values are defined. -`style` | [`type`](#data-types) | `in` | Comments ------------ | ------ | -------- | -------- -matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) -label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) -form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. -simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. -spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. -pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. -deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. - +| `style` | [`type`](#data-types) | `in` | Comments | +| -------------- | ------------------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| spaceDelimited | `array` | `query` | Space separated array values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| pipeDelimited | `array` | `query` | Pipe separated array values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. | ##### Style Examples @@ -1066,21 +1059,22 @@ Assume a parameter named `color` has one of the following values: array -> ["blue","black","brown"] object -> { "R": 100, "G": 200, "B": 150 } ``` + The following table shows examples of rendering differences for each value. -[`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` ------------ | ------ | -------- | -------- | -------- | ------- -matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 -matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 -label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 -label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 -form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 -form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 -simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 -simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 -spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 -pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200\|B\|150 -deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 +| [`style`](#dataTypeFormat) | `explode` | `empty` | `string` | `array` | `object` | +| -------------------------- | --------- | ------- | ----------- | ----------------------------------- | -------------------------------------- | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +| simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 | +| spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 | +| pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200\|B\|150 | +| deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1119,6 +1113,7 @@ style: simple ``` A path parameter of a string value: + ```json { "name": "username", @@ -1141,6 +1136,7 @@ schema: ``` An optional query parameter of a string value, allowing multiple values by repeating the query parameter: + ```json { "name": "id", @@ -1172,6 +1168,7 @@ explode: true ``` A free-form query parameter, allowing undefined parameters of a specific type: + ```json { "in": "query", @@ -1180,7 +1177,7 @@ A free-form query parameter, allowing undefined parameters of a specific type: "type": "object", "additionalProperties": { "type": "integer" - }, + } }, "style": "form" } @@ -1206,10 +1203,7 @@ A complex parameter using `content` to define serialization: "application/json": { "schema": { "type": "object", - "required": [ - "lat", - "long" - ], + "required": ["lat", "long"], "properties": { "lat": { "type": "number" @@ -1246,18 +1240,19 @@ content: Describes a single request body. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. +| Field Name | Type | Description | +| ------------------------------------------------ | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ##### Request Body Examples A request body with a referenced model definition. + ```json { "description": "user to add to the system", @@ -1267,36 +1262,36 @@ A request body with a referenced model definition. "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User Example", - "externalValue": "http://foo.bar/examples/user-example.json" - } + "user": { + "summary": "User Example", + "externalValue": "http://foo.bar/examples/user-example.json" } + } }, "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User example in XML", - "externalValue": "http://foo.bar/examples/user-example.xml" - } + "user": { + "summary": "User example in XML", + "externalValue": "http://foo.bar/examples/user-example.xml" } + } }, "text/plain": { "examples": { - "user" : { - "summary": "User example in Plain text", - "externalValue": "http://foo.bar/examples/user-example.txt" + "user": { + "summary": "User example in Plain text", + "externalValue": "http://foo.bar/examples/user-example.txt" } } }, "*/*": { "examples": { - "user" : { - "summary": "User example in other format", - "externalValue": "http://foo.bar/examples/user-example.whatever" + "user": { + "summary": "User example in other format", + "externalValue": "http://foo.bar/examples/user-example.whatever" } } } @@ -1307,33 +1302,34 @@ A request body with a referenced model definition. ```yaml description: user to add to the system content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example - externalValue: 'http://foo.bar/examples/user-example.json' - 'application/xml': + externalValue: "http://foo.bar/examples/user-example.json" + "application/xml": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example in XML - externalValue: 'http://foo.bar/examples/user-example.xml' - 'text/plain': + externalValue: "http://foo.bar/examples/user-example.xml" + "text/plain": examples: user: summary: User example in text plain format - externalValue: 'http://foo.bar/examples/user-example.txt' - '*/*': + externalValue: "http://foo.bar/examples/user-example.txt" + "*/*": examples: user: summary: User example in other format - externalValue: 'http://foo.bar/examples/user-example.whatever' + externalValue: "http://foo.bar/examples/user-example.whatever" ``` A body parameter that is an array of string values: + ```json { "description": "user to add to the system", @@ -1361,17 +1357,18 @@ content: type: string ``` - #### Media Type Object + Each Media Type Object provides schema and examples for the media type identified by its key. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the content of the request, response, or parameter. -example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. -encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. + +| Field Name | Type | Description | +| ---------------------------------------- | :----------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the content of the request, response, or parameter. | +| example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1381,30 +1378,29 @@ This object MAY be extended with [Specification Extensions](#specification-exten { "application/json": { "schema": { - "$ref": "#/components/schemas/Pet" + "$ref": "#/components/schemas/Pet" }, "examples": { - "cat" : { + "cat": { "summary": "An example of a cat", - "value": - { - "name": "Fluffy", - "petType": "Cat", - "color": "White", - "gender": "male", - "breed": "Persian" - } + "value": { + "name": "Fluffy", + "petType": "Cat", + "color": "White", + "gender": "male", + "breed": "Persian" + } }, "dog": { "summary": "An example of a dog with a cat's name", - "value" : { + "value": { "name": "Puma", "petType": "Dog", "color": "Black", "gender": "Female", "breed": "Mixed" }, - "frog": { + "frog": { "$ref": "#/components/examples/frog-example" } } @@ -1476,15 +1472,15 @@ In addition, specific media types MAY be specified: # multiple, specific media types may be specified: requestBody: content: - # a binary file of type png or jpeg - 'image/jpeg': + # a binary file of type png or jpeg + "image/jpeg": schema: type: string format: binary - 'image/png': + "image/png": schema: type: string - format: binary + format: binary ``` To upload multiple files, a `multipart` media type MUST be used: @@ -1501,7 +1497,6 @@ requestBody: items: type: string format: binary - ``` ##### Support for x-www-form-urlencoded Request Bodies @@ -1525,20 +1520,19 @@ requestBody: properties: {} ``` -In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. +In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. When passing complex objects in the `application/x-www-form-urlencoded` content type, the default serialization strategy of such properties is described in the [`Encoding Object`](#encoding-object)'s [`style`](#encodingStyle) property as `form`. ##### Special Considerations for `multipart` Content -It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. +It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. When passing in `multipart` types, boundaries MAY be used to separate sections of the content being transferred — thus, the following default `Content-Type`s are defined for `multipart`: -* If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` -* If the property is complex, or an array of complex values, the default Content-Type is `application/json` -* If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` - +- If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` +- If the property is complex, or an array of complex values, the default Content-Type is `application/json` +- If the property is a `type: string` with `format: binary` or `format: base64` (aka a file object), the default Content-Type is `application/octet-stream` Examples: @@ -1569,23 +1563,24 @@ requestBody: # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example) type: array items: - type: '#/components/schemas/Address' + type: "#/components/schemas/Address" ``` -An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. +An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. #### Encoding Object A single encoding definition applied to a single schema property. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. -style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. + +| Field Name | Type | Description | +| ------------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `string` with `format` being `binary` – `application/octet-stream`; for other primitive types – `text/plain`; for `object` - `application/json`; for `array` – the default is defined based on the inner type. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. | +| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1644,15 +1639,16 @@ The `Responses Object` MUST contain at least one response code, and it SHOULD be the response for a successful operation call. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. + +| Field Name | Type | Description | +| -------------------------------------- | :--------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's components/responses](#componentsResponses) section defines. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -[HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. +| Field Pattern | Type | Description | +| ------------------------------------------------------------------ | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's components/responses](#componentsResponses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1686,31 +1682,33 @@ A 200 response for a successful operation and a default response for others (imp ``` ```yaml -'200': +"200": description: a pet to be returned content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: Unexpected error content: application/json: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` #### Response Object + Describes a single response from an API Operation, including design-time, static `links` to operations based on the response. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. -content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* -links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). + +| Field Name | Type | Description | +| --------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | **REQUIRED**. A short description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/\* | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1741,7 +1739,7 @@ content: schema: type: array items: - $ref: '#/components/schemas/VeryComplexType' + $ref: "#/components/schemas/VeryComplexType" ``` Response with a string type: @@ -1756,7 +1754,6 @@ Response with a string type: } } } - } ``` @@ -1810,7 +1807,7 @@ content: text/plain: schema: type: string - example: 'whoa!' + example: "whoa!" headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period @@ -1845,9 +1842,10 @@ Each value in the map is a [Path Item Object](#path-item-object) that describes The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. + +| Field Pattern | Type | Description | +| --------------------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1881,34 +1879,33 @@ Location: http://example.org/subscription/1 The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. -Expression | Value ----|:--- -$url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning -$method | POST -$request.path.eventType | myevent -$request.query.queryUrl | http://clientdomain.com/stillrunning -$request.header.content-Type | application/json -$request.body#/failedUrl | http://clientdomain.com/failed -$request.body#/successUrls/2 | http://clientdomain.com/medium -$response.header.Location | http://example.org/subscription/1 - +| Expression | Value | +| ---------------------------- | :--------------------------------------------------------------------------------- | +| $url | http://example.org/subscribe/myevent?queryUrl=http://clientdomain.com/stillrunning | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | http://clientdomain.com/stillrunning | +| $request.header.content-Type | application/json | +| $request.body#/failedUrl | http://clientdomain.com/failed | +| $request.body#/successUrls/2 | http://clientdomain.com/medium | +| $response.header.Location | http://example.org/subscription/1 | ##### Callback Object Examples -The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is an example of how to use a callback object to describe a WebHook callback that goes with the subscription operation to enable registering for the WebHook. +The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is an example of how to use a callback object to describe a WebHook callback that goes with the subscription operation to enable registering for the WebHook. ```yaml myCallback: - '{$request.query.queryUrl}': + "{$request.query.queryUrl}": post: requestBody: description: Callback payload content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` @@ -1916,33 +1913,34 @@ The following example shows a callback where the server is hard-coded, but the q ```yaml transactionCallback: - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + "http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}": post: requestBody: description: Callback payload content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` #### Example Object ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -summary | `string` | Short description for the example. -description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. -externalValue | `string` | A 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. + +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | Short description for the example. | +| description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | +| externalValue | `string` | A 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). In all cases, the example value is expected to be compatible with the type schema -of its associated value. Tooling implementations MAY choose to +of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible. ##### Example Object Examples @@ -1952,58 +1950,57 @@ In a request body: ```yaml requestBody: content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" examples: foo: summary: A foo example - value: {"foo": "bar"} + value: { "foo": "bar" } bar: summary: A bar example - value: {"bar": "baz"} - 'application/xml': + value: { "bar": "baz" } + "application/xml": examples: xmlExample: summary: This is an example in XML - externalValue: 'http://example.org/examples/address-example.xml' - 'text/plain': + externalValue: "http://example.org/examples/address-example.xml" + "text/plain": examples: textExample: summary: This is a text example - externalValue: 'http://foo.bar/examples/address-example.txt' + externalValue: "http://foo.bar/examples/address-example.txt" ``` In a parameter: ```yaml parameters: - - name: 'zipCode' - in: 'query' + - name: "zipCode" + in: "query" schema: - type: 'string' - format: 'zip-code' + type: "string" + format: "zip-code" examples: zip-example: - $ref: '#/components/examples/zip-example' + $ref: "#/components/examples/zip-example" ``` In a response: ```yaml responses: - '200': + "200": description: your car appointment has been booked content: application/json: schema: - $ref: '#/components/schemas/SuccessResponse' + $ref: "#/components/schemas/SuccessResponse" examples: confirmation-success: - $ref: '#/components/examples/confirmation-success' + $ref: "#/components/examples/confirmation-success" ``` - #### Link Object The `Link object` represents a possible design-time link for a response. @@ -2011,18 +2008,18 @@ The presence of a link does not guarantee the caller's ability to successfully i Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response. -For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. +For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -operationRef | `string` | A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. -operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. -parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). -requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. -description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -server | [Server Object](#server-object) | A server object to be used by the target operation. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| operationRef | `string` | A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). | +| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#server-object) | A server object to be used by the target operation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2039,15 +2036,15 @@ Computing a link from a request operation where the `$request.path.id` is used t paths: /users/{id}: parameters: - - name: id - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: id + in: path + required: true + description: the user identifier, as userId + schema: + type: string get: responses: - '200': + "200": description: the user being returned content: application/json: @@ -2067,17 +2064,17 @@ paths: # the path item of the linked operation /users/{userid}/address: parameters: - - name: userid - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: userid + in: path + required: true + description: the user identifier, as userId + schema: + type: string # linked operation get: operationId: getUserAddress responses: - '200': + "200": description: the user's address ``` @@ -2098,7 +2095,6 @@ Clients follow all links at their discretion. Neither permissions, nor the capability to make a successful call to that link, is guaranteed solely by the existence of a relationship. - ##### OperationRef Examples As references to `operationId` MAY NOT be possible (the `operationId` is an optional @@ -2108,7 +2104,7 @@ field in an [Operation Object](#operation-object)), references MAY also be made links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: '#/paths/~12.0~1repositories~1{username}/get' + operationRef: "#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2119,7 +2115,7 @@ or an absolute `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: 'https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get' + operationRef: "https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2127,7 +2123,6 @@ links: Note that in the use of `operationRef`, the _escaped forward-slash_ is necessary when using JSON references. - ##### Runtime Expressions Runtime expressions allow defining values based on information that will only be available within the HTTP message in an actual API call. @@ -2139,7 +2134,7 @@ The runtime expression is defined by the following [ABNF](https://tools.ietf.org expression = ( "$url" / "$method" / "$statusCode" / "$request." source / "$response." source ) source = ( header-reference / query-reference / path-reference / body-reference ) header-reference = "header." token - query-reference = "query." name + query-reference = "query." name path-reference = "path." name body-reference = "body" ["#" json-pointer ] json-pointer = *( "/" reference-token ) @@ -2162,15 +2157,15 @@ The table below provides examples of runtime expressions and examples of their u ##### Examples -Source Location | example expression | notes ----|:---|:---| -HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. -Requested media type | `$request.header.accept` | -Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. -Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. -Request URL | `$url` | -Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. -Response header | `$response.header.Server` | Single header values only are available +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | Runtime expressions preserve the type of the referenced value. Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. @@ -2208,11 +2203,12 @@ Adds metadata to a single tag that is used by the [Operation Object](#operation- It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the tag. -description | `string` | A short description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. + +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the tag. | +| description | `string` | A short description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2220,8 +2216,8 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "name": "pet", - "description": "Pets operations" + "name": "pet", + "description": "Pets operations" } ``` @@ -2230,7 +2226,6 @@ name: pet description: Pets operations ``` - #### Reference Object A simple object to allow referencing other components in the specification, internally and externally. @@ -2240,9 +2235,10 @@ The Reference Object is defined by [JSON Reference](https://tools.ietf.org/html/ For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | **REQUIRED**. The reference string. + +| Field Name | Type | Description | +| ------------------------------- | :------: | ----------------------------------- | +| $ref | `string` | **REQUIRED**. The reference string. | This object cannot be extended with additional properties and any properties added SHALL be ignored. @@ -2250,15 +2246,16 @@ This object cannot be extended with additional properties and any properties add ```json { - "$ref": "#/components/schemas/Pet" + "$ref": "#/components/schemas/Pet" } ``` ```yaml -$ref: '#/components/schemas/Pet' +$ref: "#/components/schemas/Pet" ``` ##### Relative Schema Document Example + ```json { "$ref": "Pet.json" @@ -2270,6 +2267,7 @@ $ref: Pet.yaml ``` ##### Relative Documents With Embedded Schema Example + ```json { "$ref": "definitions.json#/Pet" @@ -2311,6 +2309,7 @@ The following properties are taken directly from the JSON Schema definition and - enum The following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification. + - type - Value MUST be a string. Multiple types via an array are not supported. - allOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. - oneOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. @@ -2330,32 +2329,34 @@ Additional properties defined by the JSON Schema specification that are not ment Other than the JSON Schema subset fields, the following fields MAY be used for further schema documentation: ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -nullable | `boolean` | A `true` value adds `"null"` to the allowed type specified by the `type` keyword, only if `type` is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of `null` as a value. A `false` value leaves the specified or default `type` unmodified. The default value is `false`. -discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. -readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". 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`. -writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". 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`. -xml | [XML Object](#xml-object) | 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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. -example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. - deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. + +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| nullable | `boolean` | A `true` value adds `"null"` to the allowed type specified by the `type` keyword, only if `type` is explicitly defined within the same Schema Object. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of `null` as a value. A `false` value leaves the specified or default `type` unmodified. The default value is `false`. | +| discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. | +| readOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "read only". 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`. | +| writeOnly | `boolean` | Relevant only for Schema `"properties"` definitions. Declares the property as "write only". 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`. | +| xml | [XML Object](#xml-object) | 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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. | +| deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ###### Composition and Inheritance (Polymorphism) The OpenAPI Specification allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition. -`allOf` takes an array of object definitions that are validated *independently* but together compose a single object. +`allOf` takes an array of object definitions that are validated _independently_ but together compose a single object. While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, the OpenAPI Specification adds the `discriminator` field. When used, the `discriminator` will be the name of the property that decides which schema definition validates the structure of the model. As such, the `discriminator` field MUST be a required field. There are two ways to define the value of a discriminator for an inheriting instance. + - Use the schema name. - Override the schema name by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. -As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism. + As such, inline schema definitions, which do not have a given id, _cannot_ be used in polymorphism. ###### XML Modeling @@ -2383,9 +2384,7 @@ format: email ```json { "type": "object", - "required": [ - "name" - ], + "required": ["name"], "properties": { "name": { "type": "string" @@ -2405,12 +2404,12 @@ format: email ```yaml type: object required: -- name + - name properties: name: type: string address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" age: type: integer format: int32 @@ -2450,7 +2449,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/components/schemas/ComplexModel' + $ref: "#/components/schemas/ComplexModel" ``` ###### Model with Example @@ -2467,9 +2466,7 @@ additionalProperties: "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "example": { "name": "Puma", "id": 1 @@ -2486,7 +2483,7 @@ properties: name: type: string required: -- name + - name example: name: Puma id: 1 @@ -2500,10 +2497,7 @@ example: "schemas": { "ErrorModel": { "type": "object", - "required": [ - "message", - "code" - ], + "required": ["message", "code"], "properties": { "message": { "type": "string" @@ -2522,9 +2516,7 @@ example: }, { "type": "object", - "required": [ - "rootCause" - ], + "required": ["rootCause"], "properties": { "rootCause": { "type": "string" @@ -2544,8 +2536,8 @@ components: ErrorModel: type: object required: - - message - - code + - message + - code properties: message: type: string @@ -2555,13 +2547,13 @@ components: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/components/schemas/ErrorModel' - - type: object - required: - - rootCause - properties: - rootCause: - type: string + - $ref: "#/components/schemas/ErrorModel" + - type: object + required: + - rootCause + properties: + rootCause: + type: string ``` ###### Models with Polymorphism Support @@ -2583,10 +2575,7 @@ components: "type": "string" } }, - "required": [ - "name", - "petType" - ] + "required": ["name", "petType"] }, "Cat": { "description": "A representation of a cat. Note that `Cat` will be used as the discriminator value.", @@ -2601,17 +2590,10 @@ components: "type": "string", "description": "The measured skill for hunting", "default": "lazy", - "enum": [ - "clueless", - "lazy", - "adventurous", - "aggressive" - ] + "enum": ["clueless", "lazy", "adventurous", "aggressive"] } }, - "required": [ - "huntingSkill" - ] + "required": ["huntingSkill"] } ] }, @@ -2632,9 +2614,7 @@ components: "minimum": 0 } }, - "required": [ - "packSize" - ] + "required": ["packSize"] } ] } @@ -2656,51 +2636,52 @@ components: petType: type: string required: - - name - - petType - Cat: ## "Cat" will be used as the discriminator value + - name + - petType + Cat: ## "Cat" will be used as the discriminator value description: A representation of a cat allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - huntingSkill: - type: string - description: The measured skill for hunting - enum: - - clueless - - lazy - - adventurous - - aggressive - required: - - huntingSkill - Dog: ## "Dog" will be used as the discriminator value + - $ref: "#/components/schemas/Pet" + - type: object + properties: + huntingSkill: + type: string + description: The measured skill for hunting + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill + Dog: ## "Dog" will be used as the discriminator value description: A representation of a dog allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - packSize: - type: integer - format: int32 - description: the size of the pack the dog is from - default: 0 - minimum: 0 - required: - - packSize + - $ref: "#/components/schemas/Pet" + - type: object + properties: + packSize: + type: integer + format: int32 + description: the size of the pack the dog is from + default: 0 + minimum: 0 + required: + - packSize ``` #### Discriminator Object -When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. +When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. When using the discriminator, _inline_ schemas will not be considered. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. - mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. + +| Field Name | Type | Description | +| ------------------------------------------- | :---------------------: | --------------------------------------------------------------------------------------------- | +| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. | +| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. | The discriminator object is legal only when using one of the composite keywords `oneOf`, `anyOf`, `allOf`. @@ -2709,25 +2690,24 @@ In OAS 3.0, a response payload MAY be described to be exactly one of any number ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" ``` -which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: - +which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" discriminator: propertyName: petType ``` -The expectation now is that a property with name `petType` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: +The expectation now is that a property with name `petType` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: ```json { @@ -2743,22 +2723,22 @@ In scenarios where the value of the discriminator field does not match the schem ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' - - $ref: 'https://gigantic-server.com/schemas/Monster/schema.json' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" + - $ref: "https://gigantic-server.com/schemas/Monster/schema.json" discriminator: propertyName: petType mapping: - dog: '#/components/schemas/Dog' - monster: 'https://gigantic-server.com/schemas/Monster/schema.json' + dog: "#/components/schemas/Dog" + monster: "https://gigantic-server.com/schemas/Monster/schema.json" ``` -Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. +Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. When used in conjunction with the `anyOf` construct, the use of the discriminator can avoid ambiguity where multiple schemas may satisfy a single payload. -In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. +In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. For example: @@ -2768,7 +2748,7 @@ components: Pet: type: object required: - - petType + - petType properties: petType: type: string @@ -2778,28 +2758,28 @@ components: dog: Dog Cat: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Cat` - properties: - name: - type: string + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Cat` + properties: + name: + type: string Dog: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Dog` - properties: - bark: - type: string + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Dog` + properties: + bark: + type: string Lizard: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Lizard` - properties: - lovesRocks: - type: boolean + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Lizard` + properties: + lovesRocks: + type: boolean ``` a payload like this: @@ -2811,7 +2791,7 @@ a payload like this: } ``` -will indicate that the `Cat` schema be used. Likewise this schema: +will indicate that the `Cat` schema be used. Likewise this schema: ```json { @@ -2822,22 +2802,22 @@ will indicate that the `Cat` schema be used. Likewise this schema: will map to `Dog` because of the definition in the `mappings` element. - #### XML Object A metadata object that allows for more fine-tuned XML model definitions. -When using arrays, XML element names are *not* inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. +When using arrays, XML element names are _not_ inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. See examples for expected behavior. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. -namespace | `string` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. -prefix | `string` | The prefix to be used for the [name](#xmlName). -attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. -wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). + +| Field Name | Type | Description | +| ------------------------------------ | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | The URI of the namespace definition. Value MUST be in the form of an absolute URI. | +| prefix | `string` | The prefix to be used for the [name](#xmlName). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2851,9 +2831,9 @@ Basic string property: ```json { - "animals": { - "type": "string" - } + "animals": { + "type": "string" + } } ``` @@ -2870,12 +2850,12 @@ Basic string array property ([`wrapped`](#xmlWrapped) is `false` by default): ```json { - "animals": { - "type": "array", - "items": { - "type": "string" - } + "animals": { + "type": "array", + "items": { + "type": "string" } + } } ``` @@ -2916,7 +2896,6 @@ animals: ... ``` - ###### XML Attribute, Prefix and Namespace In this example, a full model definition is shown. @@ -3182,16 +3161,17 @@ Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in [RFC6749](https://tools.ietf.org/html/rfc6749), and [OpenID Connect Discovery](https://tools.ietf.org/html/draft-ietf-oauth-discovery-06). ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. -description | `string` | Any | A short description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. -in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. -scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). -bearerFormat | `string` | `http` (`"bearer"`) | 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. -flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. -openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. + +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------- | :---------------------------------------: | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A short description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). | +| bearerFormat | `string` | `http` (`"bearer"`) | 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. | +| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3233,7 +3213,7 @@ in: header { "type": "http", "scheme": "bearer", - "bearerFormat": "JWT", + "bearerFormat": "JWT" } ``` @@ -3275,12 +3255,13 @@ flows: Allows configuration of the supported OAuth Flows. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -implicit| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow -password| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow -clientCredentials| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. -authorizationCode| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. + +| Field Name | Type | Description | +| ----------------------------------------------------------- | :-------------------------------------: | ---------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | +| clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3289,12 +3270,13 @@ This object MAY be extended with [Specification Extensions](#specification-exten Configuration details for a supported OAuth Flow ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. -tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. -refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. -scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. + +| Field Name | Type | Applies To | Description | +| -------------------------------------------------------- | :---------------------: | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3351,9 +3333,9 @@ When a list of Security Requirement Objects is defined on the [OpenAPI Object](# ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MUST be empty. +| Field Pattern | Type | Description | +| --------------------------------------------- | :--------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MUST be empty. | ##### Security Requirement Object Examples @@ -3373,17 +3355,14 @@ api_key: [] ```json { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ``` ```yaml petstore_auth: -- write:pets -- read:pets + - write:pets + - read:pets ``` ###### Optional OAuth2 Security @@ -3395,10 +3374,7 @@ Optional OAuth2 security as would be defined in an Ope "security": [ {}, { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] } @@ -3408,8 +3384,8 @@ Optional OAuth2 security as would be defined in an Ope security: - {} - petstore_auth: - - write:pets - - read:pets + - write:pets + - read:pets ``` ### Specification Extensions @@ -3418,9 +3394,9 @@ While the OpenAPI Specification tries to accommodate most use cases, additional The extensions properties are implemented as patterned fields that are always prefixed by `"x-"`. -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. +| Field Pattern | Type | Description | +| -------------------------------- | :--: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be `null`, a primitive, an array or an object. Can have any valid JSON format value. | The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). @@ -3438,17 +3414,17 @@ Two examples of this: ## Appendix A: Revision History -Version | Date | Notes ---- | --- | --- -3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 -3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 -3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 -3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 -3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification -3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification -3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification -2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative -2.0 | 2014-09-08 | Release of Swagger 2.0 -1.2 | 2014-03-14 | Initial release of the formal document. -1.1 | 2012-08-22 | Release of Swagger 1.1 -1.0 | 2011-08-10 | First release of the Swagger Specification +| Version | Date | Notes | +| --------- | ---------- | ------------------------------------------------- | +| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | +| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | +| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | diff --git a/3.0/3.0.4.md b/3.0/3.0.4.md index 90cdc0a..59432fd 100644 --- a/3.0/3.0.4.md +++ b/3.0/3.0.4.md @@ -114,8 +114,8 @@ Patterned fields MUST have unique names within the containing object. In order to preserve the ability to round-trip between YAML and JSON formats, YAML version [1.2](https://yaml.org/spec/1.2/spec.html) is RECOMMENDED along with some additional constraints: -* Tags MUST be limited to those allowed by [YAML's JSON schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231), which defines a subset of the YAML syntax and is unrelated to [[JSON-Schema-05|JSON Schema]]. -* Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](https://yaml.org/spec/1.2/spec.html#id2802346). +- Tags MUST be limited to those allowed by [YAML's JSON schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231), which defines a subset of the YAML syntax and is unrelated to [[JSON-Schema-05|JSON Schema]]. +- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](https://yaml.org/spec/1.2/spec.html#id2802346). **Note:** While APIs may be described by OpenAPI Descriptions in either YAML or JSON format, the API request and response bodies and other content are not required to be JSON or YAML. @@ -131,9 +131,9 @@ It is RECOMMENDED that the entry document of an OAD be named: `openapi.json` or JSON or YAML objects within an OAD are interpreted as specific Objects (such as [Operation Objects](#operation-object), [Response Objects](#response-object), [Reference Objects](#reference-object), etc.) based on their context. Depending on how references are arranged, a given JSON or YAML object can be interpreted in multiple different contexts: -* As the root object of the [entry document](#openapi-description-structure), which is always interpreted as an OpenAPI Object -* As the Object type implied by its parent Object within the document -* As a reference target, with the Object type matching the reference source's context +- As the root object of the [entry document](#openapi-description-structure), which is always interpreted as an OpenAPI Object +- As the Object type implied by its parent Object within the document +- As a reference target, with the Object type matching the reference source's context If the same JSON/YAML object is parsed multiple times and the respective contexts require it to be parsed as _different_ Object types, the resulting behavior is _implementation defined_, and MAY be treated as an error if detected. An example would be referencing an empty Schema Object under `#/components/schemas` where a Path Item Object is expected, as an empty object is valid for both types. For maximum interoperability, it is RECOMMENDED that OpenAPI Description authors avoid such scenarios. @@ -144,12 +144,12 @@ Several features of this specification require resolution of non-URI-based conne These connections are unambiguously resolved in single-document OADs, but the resolution process in multi-document OADs is _implementation-defined_, within the constraints described in this section. In some cases, an unambiguous URI-based alternative is available, and OAD authors are RECOMMENDED to always use the alternative: -| Source | Target | Alternative | -| ---- | ---- | ---- | -| [Security Requirement Object](#security-requirement-object) `{name}` | [Security Scheme Object](#security-scheme-object) name under the [Components Object](#components-object) | _n/a_ | -| [Discriminator Object](#discriminator-object) `mapping` _(implicit, or explicit name syntax)_ | [Schema Object](#schema-object) name under the Components Object | `mapping` _(explicit URI syntax)_ | -| [Operation Object](#operation-object) `tags` | [Tag Object](#tag-object) `name` (in the [OpenAPI Object](#openapi-object)'s `tags` array) | _n/a_ | -| [Link Object](#link-object) `operationId` | [Path Item Object](#path-item-object) `operationId` | `operationRef` | +| Source | Target | Alternative | +| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------- | +| [Security Requirement Object](#security-requirement-object) `{name}` | [Security Scheme Object](#security-scheme-object) name under the [Components Object](#components-object) | _n/a_ | +| [Discriminator Object](#discriminator-object) `mapping` _(implicit, or explicit name syntax)_ | [Schema Object](#schema-object) name under the Components Object | `mapping` _(explicit URI syntax)_ | +| [Operation Object](#operation-object) `tags` | [Tag Object](#tag-object) `name` (in the [OpenAPI Object](#openapi-object)'s `tags` array) | _n/a_ | +| [Link Object](#link-object) `operationId` | [Path Item Object](#path-item-object) `operationId` | `operationRef` | A fifth implicit connection involves appending the templated URL paths of the [Paths Object](#paths-object) to the appropriate [Server Object](#server-object)'s `url` field. This is unambiguous because only the entry document's Paths Object contributes URLs to the described API. @@ -197,24 +197,24 @@ For the purpose of [JSON Schema validation](https://datatracker.ietf.org/doc/htm The formats defined by the OAS are: -| `format` | JSON Data Type | Comments | -| ---- | ---- | ---- | -| `int32` | number | signed 32 bits | -| `int64` | number | signed 64 bits (a.k.a long) | -| `float` | number | | -| `double` | number | | -| `byte` | string | base64 encoded characters - [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4) | -| `binary` | string | any sequence of octets | -| `date` | string | As defined by `full-date` - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) | -| `date-time` | string | As defined by `date-time` - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) | -| `password` | string | A hint to obscure the value. | +| `format` | JSON Data Type | Comments | +| ----------- | -------------- | ----------------------------------------------------------------------------------------- | +| `int32` | number | signed 32 bits | +| `int64` | number | signed 64 bits (a.k.a long) | +| `float` | number | | +| `double` | number | | +| `byte` | string | base64 encoded characters - [RFC4648](https://www.rfc-editor.org/rfc/rfc4648#section-4) | +| `binary` | string | any sequence of octets | +| `date` | string | As defined by `full-date` - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) | +| `date-time` | string | As defined by `date-time` - [RFC3339](https://www.rfc-editor.org/rfc/rfc3339#section-5.6) | +| `password` | string | A hint to obscure the value. | #### Working with Binary Data Two formats, `binary` and `byte`, describe different ways to work with binary data: -* `binary` is used where unencoded binary data is allowed, such as when sending a binary payload as an HTTP message body, or as part of a `multipart/*` payload that allows binary parts -* `byte` is used where binary data is embedded in a text-only format such as `application/json` or `application/x-www-form-urlencoded` +- `binary` is used where unencoded binary data is allowed, such as when sending a binary payload as an HTTP message body, or as part of a `multipart/*` payload that allows binary parts +- `byte` is used where binary data is embedded in a text-only format such as `application/json` or `application/x-www-form-urlencoded` The `maxLength` keyword MAY be used to set an expected upper bound on the length of a streaming payload. The keyword can be applied to either string data, including encoded binary data, or to unencoded binary data. For unencoded binary, the length is the number of octets. @@ -236,7 +236,7 @@ Relative references are resolved using the URLs defined in the [Server Object](# Relative references used in `$ref` are processed as per [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03), using the URL of the current document as the base URI. See also the [Reference Object](#reference-object). -It is _implementation_defined_ whether the resolution of relative references in each of the `operationRef` field of the [Link Object](#link-object), the URI form of the `mapping` field of the [Discriminator Object](#discriminator-object), the `externalValue` field of the [Example Object](#example-object), and the `url` fields of the [External Documentation](#external-documentation-object), [Contact](#contact-object), and [License](#license-object) Objects resolve by using the same process as `$ref` or by using the Server Object. For compatibility with future versions of this specification, the `$ref` process is RECOMMENDED for all of these fields. +It is _implementation_defined_ whether the resolution of relative references in each of the `operationRef` field of the [Link Object](#link-object), the URI form of the `mapping` field of the [Discriminator Object](#discriminator-object), the `externalValue` field of the [Example Object](#example-object), and the `url` fields of the [External Documentation](#external-documentation-object), [Contact](#contact-object), and [License](#license-object) Objects resolve by using the same process as `$ref` or by using the Server Object. For compatibility with future versions of this specification, the `$ref` process is RECOMMENDED for all of these fields. Relative references in CommonMark hyperlinks are resolved in their rendered context, which might differ from the context of the API description. @@ -255,16 +255,16 @@ This is the root object of the [OpenAPI Description](#openapi-description). ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the OpenAPI Specification that the OpenAPI Document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI Document. This is _not_ related to the API [`info.version`](#info-version) string. | -| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | -| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` field is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#server-url) value of `/`. | -| paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. | -| components | [Components Object](#components-object) | An element to hold various Objects for the OpenAPI Description. | -| security | [[Security Requirement Object](#security-requirement-object)] | 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. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement (`{}`) can be included in the array. | -| tags | [[Tag Object](#tag-object)] | A list of tags used by the OpenAPI Description 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](#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. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | +| Field Name | Type | Description | +| -------------------------------------------- | :-------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the OpenAPI Specification that the OpenAPI Document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI Document. This is _not_ related to the API [`info.version`](#info-version) string. | +| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` field is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#server-url) value of `/`. | +| paths | [Paths Object](#paths-object) | **REQUIRED**. The available paths and operations for the API. | +| components | [Components Object](#components-object) | An element to hold various Objects for the OpenAPI Description. | +| security | [[Security Requirement Object](#security-requirement-object)] | 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. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement (`{}`) can be included in the array. | +| tags | [[Tag Object](#tag-object)] | A list of tags used by the OpenAPI Description 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -275,14 +275,14 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| title | `string` | **REQUIRED**. The title of the API. | -| description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| termsOfService | `string` | A URL for the Terms of Service for the API. This MUST be in the form of a URL. | -| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | -| license | [License Object](#license-object) | The license information for the exposed API. | -| version | `string` | **REQUIRED**. The version of the OpenAPI Document (which is distinct from the [OpenAPI Specification version](#oas-version) or the version of the API being described or the version of the OpenAPI Description). | +| Field Name | Type | Description | +| -------------------------------------------------- | :-------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **REQUIRED**. The title of the API. | +| description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | A URL for the Terms of Service for the API. This MUST be in the form of a URL. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **REQUIRED**. The version of the OpenAPI Document (which is distinct from the [OpenAPI Specification version](#oas-version) or the version of the API being described or the version of the OpenAPI Description). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -326,10 +326,10 @@ Contact information for the exposed API. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | The identifying name of the contact person/organization. | -| url | `string` | The URL for the contact information. This MUST be in the form of a URL. | +| Field Name | Type | Description | +| --------------------------------- | :------: | --------------------------------------------------------------------------------------------------- | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URL for the contact information. This MUST be in the form of a URL. | | email | `string` | The email address of the contact person/organization. This MUST be in the form of an email address. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -356,10 +356,10 @@ License information for the exposed API. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The license name used for the API. | -| url | `string` | A URL for the license used for the API. This MUST be in the form of a URL. | +| Field Name | Type | Description | +| ------------------------------- | :------: | -------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The license name used for the API. | +| url | `string` | A URL for the license used for the API. This MUST be in the form of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -383,11 +383,11 @@ An object representing a Server. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in `{`braces`}`. | -| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | +| Field Name | Type | Description | +| -------------------------------------------- | :--------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in `{`braces`}`. | +| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -475,9 +475,9 @@ servers: description: A user-specific subdomain. Use `demo` for a free sandbox environment. port: enum: - - '8443' - - '443' - default: '8443' + - "8443" + - "443" + default: "8443" basePath: # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` default: v2 @@ -489,11 +489,11 @@ An object representing a Server Variable for server URL template substitution. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty. | -| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. If the [`enum`](#server-variable-enum) is defined, the value SHOULD exist in the enum's values. Note that this behavior is different from the [Schema Object](#schema-object)'s `default` keyword, which documents the receiver's behavior rather than inserting the value into the data. | -| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| Field Name | Type | Description | +| ----------------------------------------------------- | :--------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty. | +| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. If the [`enum`](#server-variable-enum) is defined, the value SHOULD exist in the enum's values. Note that this behavior is different from the [Schema Object](#schema-object)'s `default` keyword, which documents the receiver's behavior rather than inserting the value into the data. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -504,17 +504,17 @@ All objects defined within the Components Object will have no effect on the API ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :---- | ---- | -| schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). | -| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | -| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | -| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | -| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | -| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | -| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | -| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | +| Field Name | Type | Description | +| ------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| schemas | Map[`string`, [Schema Object](#schema-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Schema Objects](#schema-object). | +| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | +| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | +| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | +| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | +| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -688,7 +688,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GeneralError' + $ref: "#/components/schemas/GeneralError" securitySchemes: api_key: type: apiKey @@ -711,8 +711,8 @@ The path is appended to the URL from the [Server Object](#server-object) in orde ##### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| -------------------------------- | :-----------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The path is **appended** (no relative URL resolution) to the expanded URL from the [Server Object](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -772,14 +772,14 @@ The following may lead to ambiguous resolution: get: description: Returns all pets from the system that the user has access to responses: - '200': + "200": description: A list of pets. content: application/json: schema: type: array items: - $ref: '#/components/schemas/pet' + $ref: "#/components/schemas/pet" ``` #### Path Item Object @@ -790,21 +790,21 @@ The path itself is still exposed to the documentation viewer but they will not k ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| $ref | `string` | Allows for a referenced definition of this path item. The value MUST be in the form of a URL, and the referenced structure MUST be in the form of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving [Relative References](#relative-references-in-urls). | -| summary | `string` | An optional string summary, intended to apply to all operations in this path. | -| description | `string` | An optional string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | -| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | -| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | -| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | -| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | -| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | -| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | -| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | -| servers | [[Server Object](#server-object)] | An alternative `servers` array to service all operations in this path. If a `servers` array is specified at the [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | -| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | +| Field Name | Type | Description | +| ----------------------------------------------- | :------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for a referenced definition of this path item. The value MUST be in the form of a URL, and the referenced structure MUST be in the form of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving [Relative References](#relative-references-in-urls). | +| summary | `string` | An optional string summary, intended to apply to all operations in this path. | +| description | `string` | An optional string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | +| servers | [[Server Object](#server-object)] | An alternative `servers` array to service all operations in this path. If a `servers` array is specified at the [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -866,20 +866,20 @@ get: summary: Find pets by ID operationId: getPetsById responses: - '200': + "200": description: pet response content: - '*/*': + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: text/html: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" parameters: - name: id in: path @@ -898,20 +898,20 @@ Describes a single API operation on a path. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | -| summary | `string` | A short summary of what the operation does. | -| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | -| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | -| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined in the [Path Item](#path-item-parameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | -| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as [GET](https://tools.ietf.org/html/rfc7231#section-4.3.1), [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)), `requestBody` SHALL be ignored by consumers. | -| responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. | -| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. | -| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | -| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oas-security). To remove a top-level security declaration, an empty array can be used. | -| servers | [[Server Object](#server-object)] | An alternative `servers` array to service this operation. If a `servers` array is specified at the [Path Item Object](#path-item-servers) or [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | +| Field Name | Type | Description | +| -------------------------------------------------- | :-----------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. | +| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined in the [Path Item](#path-item-parameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | +| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is only supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as [GET](https://tools.ietf.org/html/rfc7231#section-4.3.1), [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)), `requestBody` SHALL be ignored by consumers. | +| responses | [Responses Object](#responses-object) | **REQUIRED**. The list of possible responses as they are returned from executing this operation. | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. | +| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oas-security). To remove a top-level security declaration, an empty array can be used. | +| servers | [[Server Object](#server-object)] | An alternative `servers` array to service this operation. If a `servers` array is specified at the [Path Item Object](#path-item-servers) or [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1004,12 +1004,12 @@ requestBody: required: - status responses: - '200': + "200": description: Pet updated. content: application/json: {} application/xml: {} - '405': + "405": description: Method Not Allowed content: application/json: {} @@ -1026,10 +1026,10 @@ Allows referencing an external resource for extended documentation. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| -------------------------------------------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------- | | description | `string` | A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| url | `string` | **REQUIRED**. The URL for the target documentation. This MUST be in the form of a URL. | +| url | `string` | **REQUIRED**. The URL for the target documentation. This MUST be in the form of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1059,10 +1059,10 @@ See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a detail There are four possible parameter locations specified by the `in` field: -* path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. -* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. -* cookie - Used to pass a specific cookie value to the API. +- path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +- header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. +- cookie - Used to pass a specific cookie value to the API. ##### Fixed Fields @@ -1074,13 +1074,13 @@ See [Appendix B](#appendix-b-data-type-conversion) for a discussion of convertin These fields MAY be used with either `content` or `schema`. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameter-in) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#paths-path) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameter-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`](#parameter-in) field.
| -| in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. | -| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameter-in) is `"path"`, this field is **REQUIRED** and its value MUST be `true`. Otherwise, the field MAY be included and its default value is `false`. | -| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| Field Name | Type | Description | +| ---------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameter-in) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#paths-path) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameter-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`](#parameter-in) field.
| +| in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. | +| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameter-in) is `"path"`, this field is **REQUIRED** and its value MUST be `true`. Otherwise, the field MAY be included and its default value is `false`. | +| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | | allowEmptyValue | `boolean` | If `true`, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is `false`. If [`style`](#parameter-style) is used, and if [behavior is _n/a_ (cannot be serialized)](#style-examples), the value of `allowEmptyValue` SHALL be ignored. Interactions between this field and the parameter's [Schema Object](#schema-object) are implementation-defined. This field is valid only for `query` parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1095,14 +1095,14 @@ The `example` and `examples` fields are mutually exclusive, and if either is pre Serializing with `schema` is NOT RECOMMENDED for `in: "cookie"` parameters, `in: "header"` parameters that use HTTP header parameters (name=value pairs following a `;`) in their values, or `in: "header"` parameters where values might have non-URL-safe characters; see [Appendix D](#appendix-d-serializing-headers-and-cookies) for details. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `"query"` - `"form"`; for `"path"` - `"simple"`; for `"header"` - `"simple"`; for `"cookie"` - `"form"`. | -| explode | `boolean` | 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 field has no effect. When [`style`](#parameter-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. | -| allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are [not allowed in the query string](https://datatracker.ietf.org/doc/html/rfc3986#section-3.4) (`[`, `]`, `#`), or have a special meaning in `application/x-www-form-urlencoded` (`-`, `&`, `+`); see Appendices [C](#appendix-c-using-rfc6570-based-serialization) and [E](#appendix-e-percent-encoding-and-form-media-types) for details. This field only applies to parameters with an `in` value of `query`. The default value is `false`. | -| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. | -| example | Any | Example of the parameter's potential value; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value; see [Working With Examples](#working-with-examples). | +| Field Name | Type | Description | +| ---------------------------------------------------- | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `"query"` - `"form"`; for `"path"` - `"simple"`; for `"header"` - `"simple"`; for `"cookie"` - `"form"`. | +| explode | `boolean` | 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 field has no effect. When [`style`](#parameter-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. | +| allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are [not allowed in the query string](https://datatracker.ietf.org/doc/html/rfc3986#section-3.4) (`[`, `]`, `#`), or have a special meaning in `application/x-www-form-urlencoded` (`-`, `&`, `+`); see Appendices [C](#appendix-c-using-rfc6570-based-serialization) and [E](#appendix-e-percent-encoding-and-form-media-types) for details. This field only applies to parameters with an `in` value of `query`. The default value is `false`. | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the parameter. | +| example | Any | Example of the parameter's potential value; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value; see [Working With Examples](#working-with-examples). | See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc6570-based-serialization) for additional guidance. @@ -1111,23 +1111,23 @@ See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc65 For more complex scenarios, the [`content`](#parameter-content) field can define the media type and schema of the parameter, as well as give examples of its use. Using `content` with a `text/plain` media type is RECOMMENDED for `in: "header"` and `in: "cookie"` parameters where the `schema` strategy is not appropriate. -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| --------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | | content | Map[`string`, [Media Type Object](#media-type-object)] | 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. | ##### Style Values In order to support common ways of serializing simple parameters, a set of `style` values are defined. -| `style` | [`type`](#data-types) | `in` | Comments | -| ---- | ---- | ---- | ---- | -| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | -| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | -| simple | `primitive`, `array`, `object` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | -| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | -| spaceDelimited | `array`, `object` | `query` | Space separated array values or object properties and values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | -| pipeDelimited | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | -| deepObject | `object` | `query` | Allows objects with scalar properties to be represented using form parameters. The representation of array or object properties is not defined. | +| `style` | [`type`](#data-types) | `in` | Comments | +| -------------- | ------------------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| simple | `primitive`, `array`, `object` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| spaceDelimited | `array`, `object` | `query` | Space separated array values or object properties and values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| pipeDelimited | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| deepObject | `object` | `query` | Allows objects with scalar properties to be represented using form parameters. The representation of array or object properties is not defined. | See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a discussion of percent-encoding, including when delimiters need to be percent-encoded and options for handling collisions with percent-encoded data. @@ -1143,29 +1143,29 @@ Assume a parameter named `color` has one of the following values: The following table shows examples, as would be shown with the `example` or `examples` keywords, of the different serializations for each value. -* The value _empty_ denotes the empty string, and is unrelated to the `allowEmptyValue` field -* The behavior of combinations marked _n/a_ is undefined -* The `undefined` column replaces the `empty` column in previous versions of this specification in order to better align with [RFC6570](https://www.rfc-editor.org/rfc/rfc6570.html#section-2.3) terminology, which describes certain values including but not limited to `null` as "undefined" values with special handling; notably, the empty string is _not_ undefined -* For `form` and the non-RFC6570 query string styles `spaceDelimited`, `pipeDelimited`, and `deepObject`, each example is shown prefixed with `?` as if it were the only query parameter; see [Appendix C](#appendix-c-using-rfc6570-based-serialization) for more information on constructing query strings from multiple parameters, and [Appendix D](#appendix-d-serializing-headers-and-cookies) for warnings regarding `form` and cookie parameters -* Note that the `?` prefix is not appropriate for serializing `application/x-www-form-urlencoded` HTTP message bodies, and MUST be stripped or (if constructing the string manually) not added when used in that context; see the [Encoding Object](#encoding-object) for more information -* The examples are percent-encoded as required by RFC6570 and RFC3986; see [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a thorough discussion of percent-encoding concerns, including why unencoded `|` (`%7C`), `[` (`%5B`), and `]` (`%5D`) seem to work in some environments despite not being compliant. +- The value _empty_ denotes the empty string, and is unrelated to the `allowEmptyValue` field +- The behavior of combinations marked _n/a_ is undefined +- The `undefined` column replaces the `empty` column in previous versions of this specification in order to better align with [RFC6570](https://www.rfc-editor.org/rfc/rfc6570.html#section-2.3) terminology, which describes certain values including but not limited to `null` as "undefined" values with special handling; notably, the empty string is _not_ undefined +- For `form` and the non-RFC6570 query string styles `spaceDelimited`, `pipeDelimited`, and `deepObject`, each example is shown prefixed with `?` as if it were the only query parameter; see [Appendix C](#appendix-c-using-rfc6570-based-serialization) for more information on constructing query strings from multiple parameters, and [Appendix D](#appendix-d-serializing-headers-and-cookies) for warnings regarding `form` and cookie parameters +- Note that the `?` prefix is not appropriate for serializing `application/x-www-form-urlencoded` HTTP message bodies, and MUST be stripped or (if constructing the string manually) not added when used in that context; see the [Encoding Object](#encoding-object) for more information +- The examples are percent-encoded as required by RFC6570 and RFC3986; see [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a thorough discussion of percent-encoding concerns, including why unencoded `|` (`%7C`), `[` (`%5B`), and `]` (`%5D`) seem to work in some environments despite not being compliant. -| [`style`](#style-values) | `explode` | `undefined` | `string` | `array` | `object` | -| ---- | ---- | ---- | ---- | ---- | ---- | -| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | -| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | -| label | false | . | .blue | .blue,black,brown | .R,100,G,200,B,150 | -| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | -| simple | false | _empty_ | blue | blue,black,brown | R,100,G,200,B,150 | -| simple | true | _empty_ | blue | blue,black,brown | R=100,G=200,B=150 | -| form | false | ?color= | ?color=blue | ?color=blue,black,brown | ?color=R,100,G,200,B,150 | -| form | true | ?color= | ?color=blue | ?color=blue&color=black&color=brown | ?R=100&G=200&B=150 | -| spaceDelimited | false | _n/a_ | _n/a_ | ?color=blue%20black%20brown | ?color=R%20100%20G%20200%20B%20150 | -| spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| pipeDelimited | false | _n/a_ | _n/a_ | ?color=blue%7Cblack%7Cbrown | ?color=R%7C100%7CG%7C200%7CB%7C150 | -| pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| deepObject | false | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| deepObject | true | _n/a_ | _n/a_ | _n/a_ | ?color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150 | +| [`style`](#style-values) | `explode` | `undefined` | `string` | `array` | `object` | +| ------------------------ | --------- | ------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue,black,brown | .R,100,G,200,B,150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| simple | false | _empty_ | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | _empty_ | blue | blue,black,brown | R=100,G=200,B=150 | +| form | false | ?color= | ?color=blue | ?color=blue,black,brown | ?color=R,100,G,200,B,150 | +| form | true | ?color= | ?color=blue | ?color=blue&color=black&color=brown | ?R=100&G=200&B=150 | +| spaceDelimited | false | _n/a_ | _n/a_ | ?color=blue%20black%20brown | ?color=R%20100%20G%20200%20B%20150 | +| spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | +| pipeDelimited | false | _n/a_ | _n/a_ | ?color=blue%7Cblack%7Cbrown | ?color=R%7C100%7CG%7C200%7CB%7C150 | +| pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | +| deepObject | false | _n/a_ | _n/a_ | _n/a_ | _n/a_ | +| deepObject | true | _n/a_ | _n/a_ | _n/a_ | ?color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150 | ##### Parameter Object Examples @@ -1330,11 +1330,11 @@ Describes a single request body. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | +| Field Name | Type | Description | +| -------------------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1393,14 +1393,14 @@ description: user to add to the system content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User example externalValue: https://foo.bar/examples/user-example.json application/xml: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User example in XML @@ -1410,7 +1410,7 @@ content: user: summary: User example in plain text externalValue: https://foo.bar/examples/user-example.txt - '*/*': + "*/*": examples: user: summary: User example in other format @@ -1427,12 +1427,12 @@ See [Working With Examples](#working-with-examples) for further guidance regardi ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the content of the request, response, parameter, or header. | -| example | Any | Example of the media type; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type; see [Working With Examples](#working-with-examples). | -| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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` field SHALL only apply to [Request Body Objects](#request-body-object), and only when the media type is `multipart` or `application/x-www-form-urlencoded`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. | +| Field Name | Type | Description | +| ------------------------------------------ | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the content of the request, response, parameter, or header. | +| example | Any | Example of the media type; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type; see [Working With Examples](#working-with-examples). | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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` field SHALL only apply to [Request Body Objects](#request-body-object), and only when the media type is `multipart` or `application/x-www-form-urlencoded`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1476,7 +1476,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```yaml application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" examples: cat: summary: An example of a cat @@ -1495,7 +1495,7 @@ application/json: gender: Female breed: Mixed frog: - $ref: '#/components/examples/frog-example' + $ref: "#/components/examples/frog-example" ``` ##### Considerations for File Uploads @@ -1530,11 +1530,11 @@ In addition, specific media types MAY be specified: requestBody: content: # a binary file of type png or jpeg - 'image/jpeg': + "image/jpeg": schema: type: string format: binary - 'image/png': + "image/png": schema: type: string format: binary @@ -1566,22 +1566,22 @@ See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a detail These fields MAY be used either with or without the RFC6570-style serialization fields defined in the next section below. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| contentType | `string` | The `Content-Type` for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. `image/png`) or a wildcard media type (e.g. `image/*`). Default value depends on the property type as shown in the table below. | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers. `Content-Type` is described separately and SHALL be ignored in this section. This field SHALL be ignored if the request body media type is not a `multipart`. | +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | The `Content-Type` for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. `image/png`) or a wildcard media type (e.g. `image/*`). Default value depends on the property type as shown in the table below. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers. `Content-Type` is described separately and SHALL be ignored in this section. This field SHALL be ignored if the request body media type is not a `multipart`. | This object MAY be extended with [Specification Extensions](#specification-extensions). The default values for `contentType` are as follows, where an _n/a_ in the `format` column means that the presence or value of `format` is irrelevant: -| `type` | `format` | Default `contentType` | -| ---- | ---- | ---- | -| `string` | `binary` _or_ `byte` | `application/octet-stream` | -| `string` | _none, or any except `binary` or `byte`_ | `text/plain` | -| `number`, `integer`, or `boolean` | _n/a_ | `text/plain` | -| `object` | _n/a_ | `application/json` | -| `array` | _n/a_ | according to the `type` and `format` of the `items` schema | +| `type` | `format` | Default `contentType` | +| --------------------------------- | ---------------------------------------- | ---------------------------------------------------------- | +| `string` | `binary` _or_ `byte` | `application/octet-stream` | +| `string` | _none, or any except `binary` or `byte`_ | `text/plain` | +| `number`, `integer`, or `boolean` | _n/a_ | `text/plain` | +| `object` | _n/a_ | `application/json` | +| `array` | _n/a_ | according to the `type` and `format` of the `items` schema | Determining how to handle `null` values if `nullable: true` is present depends on how `null` values are being serialized. If `null` values are entirely omitted, then the `contentType` is irrelevant. @@ -1589,10 +1589,10 @@ See [Appendix B](#appendix-b-data-type-conversion) for a discussion of data type ###### Fixed Fields for RFC6570-style Serialization -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameter-style) field. The behavior follows the same values as `query` parameters, including default values. Note that the initial `?` used in query strings is not used in `application/x-www-form-urlencoded` message bodies, and MUST be removed (if using an RFC6570 implementation) or simply not added (if constructing the string manually). This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | -| explode | `boolean` | When this is true, property 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 properties this field has no effect. When [`style`](#encoding-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| Field Name | Type | Description | +| --------------------------------------------------- | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameter-style) field. The behavior follows the same values as `query` parameters, including default values. Note that the initial `?` used in query strings is not used in `application/x-www-form-urlencoded` message bodies, and MUST be removed (if using an RFC6570 implementation) or simply not added (if constructing the string manually). This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | +| explode | `boolean` | When this is true, property 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 properties this field has no effect. When [`style`](#encoding-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | | allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are [not allowed in the query string](https://datatracker.ietf.org/doc/html/rfc3986#section-3.4) (`[`, `]`, `#`), or have a special meaning in `application/x-www-form-urlencoded` (`-`, `&`, `+`); see Appendices [C](#appendix-c-using-rfc6570-based-serialization) and [E](#appendix-e-percent-encoding-and-form-media-types) for details. The default value is `false`. This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded`. | See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc6570-based-serialization) for additional guidance. @@ -1600,13 +1600,13 @@ See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc65 The role of `contentType` with `application/x-www-form-urlencoded` request bodies was not described in detail in version 3.0.3 and earlier of this specification. To match the intent of these fields and be compatible with version 3.1 of this specification, it is RECOMMENDED that whenever any of `style`, `explode`, or `allowReserved` are present with an explicit value: -* The value of `contentType`, whether it is explicitly defined or has the default value, is to be ignored -* If any of `style`, `explode`, or `allowReserved` are _not_ present with explicit values, then they are to be treated as if they were present with their default values +- The value of `contentType`, whether it is explicitly defined or has the default value, is to be ignored +- If any of `style`, `explode`, or `allowReserved` are _not_ present with explicit values, then they are to be treated as if they were present with their default values However, if all three of `style`, `explode`, and `allowReserved` fields are absent, it is RECOMMENDED that: -* All three keywords are to be entirely ignored, rather than treated as having their default values -* Encoding is to be based on `contentType` alone, whether it is present with an explicit value or absent and treated as having its default value +- All three keywords are to be entirely ignored, rather than treated as having their default values +- Encoding is to be based on `contentType` alone, whether it is present with an explicit value or absent and treated as having its default value Note that the presence of at least one of `style`, `explode`, or `allowReserved` with an explicit value is equivalent to using `schema` with `in: "query"` Parameter Objects. The absence of all three of those fields is the equivalent of using `content`, but with the media type specified in `contentType` rather than through a Media Type Object. @@ -1744,7 +1744,7 @@ requestBody: # subschema, which is an object, so `application/json` type: array items: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" ``` ###### Example: Multipart Form with Encoding Objects @@ -1770,7 +1770,7 @@ requestBody: description: addresses in XML format type: array items: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" profileImage: # default is application/octet-stream, but we can declare # a more specific image type or types @@ -1827,14 +1827,14 @@ call. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| --------------------------------------- | :--------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A [Reference Object](#reference-object) can link to a response that the [OpenAPI Object's `components.responses`](#components-responses) section defines. | ##### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ------------------------------------------------------------------- | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A [Reference Object](#reference-object) can link to a response that is defined in the [OpenAPI Object's `components.responses`](#components-responses) section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `200` and `299`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1869,18 +1869,18 @@ A 200 response for a successful operation and a default response for others (imp ``` ```yaml -'200': +"200": description: a pet to be returned content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: Unexpected error content: application/json: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` #### Response Object @@ -1890,12 +1890,12 @@ Describes a single response from an API operation, including design-time, static ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| description | `string` | **REQUIRED**. A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | -| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` | -| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | +| Field Name | Type | Description | +| ---------------------------------------------- | :-------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| description | `string` | **REQUIRED**. A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1926,7 +1926,7 @@ content: schema: type: array items: - $ref: '#/components/schemas/VeryComplexType' + $ref: "#/components/schemas/VeryComplexType" ``` Response with a string type: @@ -1994,7 +1994,7 @@ content: text/plain: schema: type: string - example: 'whoa!' + example: "whoa!" headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period @@ -2030,8 +2030,8 @@ The key value used to identify the Path Item Object is an expression, evaluated ##### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ---------------------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | {expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](https://learn.openapis.org/examples/v3.0/callback-example.html) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2070,16 +2070,16 @@ Location: https://example.org/subscription/1 The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. -| Expression | Value | -| ---- | :---- | -| $url | | -| $method | POST | -| $request.path.eventType | myevent | -| $request.query.queryUrl | | -| $request.header.content-type | application/json | -| $request.body#/failedUrl | | -| $request.body#/successUrls/1 | | -| $response.header.Location | | +| Expression | Value | +| ---------------------------- | :------------------------------------------------------------------------------------- | +| $url | | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | | +| $request.header.content-type | application/json | +| $request.body#/failedUrl | | +| $request.body#/successUrls/1 | | +| $response.header.Location | | ##### Callback Object Examples @@ -2087,16 +2087,16 @@ The following example uses the user provided `queryUrl` query string parameter t ```yaml myCallback: - '{$request.query.queryUrl}': + "{$request.query.queryUrl}": post: requestBody: description: Callback payload content: application/json: schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` @@ -2104,16 +2104,16 @@ The following example shows a callback where the server is hard-coded, but the q ```yaml transactionCallback: - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + "http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}": post: requestBody: description: Callback payload content: application/json: schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` @@ -2126,11 +2126,11 @@ Examples allow demonstration of the usage of properties, parameters and objects ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| summary | `string` | Short description for the example. | -| description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | +| Field Name | Type | Description | +| -------------------------------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | Short description for the example. | +| description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | | externalValue | `string` | A 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. See the rules for resolving [Relative References](#relative-references-in-urls). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2164,9 +2164,9 @@ In a request body: ```yaml requestBody: content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" examples: foo: summary: A foo example @@ -2199,22 +2199,22 @@ parameters: format: zip-code examples: zip-example: - $ref: '#/components/examples/zip-example' + $ref: "#/components/examples/zip-example" ``` In a response: ```yaml responses: - '200': + "200": description: your car appointment has been booked content: application/json: schema: - $ref: '#/components/schemas/SuccessResponse' + $ref: "#/components/schemas/SuccessResponse" examples: confirmation-success: - $ref: '#/components/examples/confirmation-success' + $ref: "#/components/examples/confirmation-success" ``` Two different uses of JSON strings: @@ -2302,14 +2302,14 @@ For computing links and providing instructions to execute them, a [runtime expre ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| operationRef | `string` | A URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). | -| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | -| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. `path.id` for an `id` parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. | -| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | -| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| server | [Server Object](#server-object) | A server object to be used by the target operation. | +| Field Name | Type | Description | +| --------------------------------------------- | :--------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| operationRef | `string` | A URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. `path.id` for an `id` parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. | +| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#server-object) | A server object to be used by the target operation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2338,7 +2338,7 @@ paths: type: string get: responses: - '200': + "200": description: the user being returned content: application/json: @@ -2368,7 +2368,7 @@ paths: get: operationId: getUserAddress responses: - '200': + "200": description: the user's address ``` @@ -2398,7 +2398,7 @@ field in an [Operation Object](#operation-object)), references MAY also be made links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: '#/paths/~12.0~1repositories~1%7Busername%7D/get' + operationRef: "#/paths/~12.0~1repositories~1%7Busername%7D/get" parameters: username: $response.body#/username ``` @@ -2451,15 +2451,15 @@ The table below provides examples of runtime expressions and examples of their u ##### Examples -| Source Location | example expression | notes | -| ---- | :---- | :---- | -| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | -| Requested media type | `$request.header.accept` | | -| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | -| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | -| Request URL | `$url` | | -| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | -| Response header | `$response.header.Server` | Single header values only are available | +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | Runtime expressions preserve the type of the referenced value. Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. @@ -2480,11 +2480,11 @@ The Header Object follows the structure of the [Parameter Object](#parameter-obj These fields MAY be used with either `content` or `schema`. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| description | `string` | A brief description of the header. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| required | `boolean` | Determines whether this header is mandatory. The default value is `false`. | -| deprecated | `boolean` | Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| Field Name | Type | Description | +| -------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| description | `string` | A brief description of the header. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this header is mandatory. The default value is `false`. | +| deprecated | `boolean` | Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2498,13 +2498,13 @@ Serializing with `schema` is NOT RECOMMENDED for headers with parameters (name=v When `example` or `examples` are provided in conjunction with the `schema` field, the example SHOULD match the specified schema and follow the prescribed serialization strategy for the header. The `example` and `examples` fields are mutually exclusive, and if either is present it SHALL _override_ any `example` in the schema. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how the header value will be serialized. The default (and only legal value for headers) is `"simple"`. | -| explode | `boolean` | When this is true, header values of type `array` or `object` generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see [Style Examples](#style-examples). For other data types this field has no effect. The default value is `false`. | -| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the header. | -| example | Any | Example of the header's potential value; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the header's potential value; see [Working With Examples](#working-with-examples). | +| Field Name | Type | Description | +| -------------------------------------- | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the header value will be serialized. The default (and only legal value for headers) is `"simple"`. | +| explode | `boolean` | When this is true, header values of type `array` or `object` generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see [Style Examples](#style-examples). For other data types this field has no effect. The default value is `false`. | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the header. | +| example | Any | Example of the header's potential value; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the header's potential value; see [Working With Examples](#working-with-examples). | See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc6570-based-serialization) for additional guidance. @@ -2513,8 +2513,8 @@ See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc65 For more complex scenarios, the [`content`](#header-content) field can define the media type and schema of the header, as well as give examples of its use. Using `content` with a `text/plain` media type is RECOMMENDED for headers where the `schema` strategy is not appropriate. -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| ------------------------------------ | :----------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------- | | content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing the representations for the header. The key is the media type and the value describes it. The map MUST only contain one entry. | ##### Header Object Example @@ -2570,11 +2570,11 @@ It is not mandatory to have a Tag Object per tag defined in the Operation Object ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The name of the tag. | -| description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | +| Field Name | Type | Description | +| -------------------------------------------- | :-------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the tag. | +| description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2602,8 +2602,8 @@ For this specification, reference resolution is accomplished as defined by the J ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| -------------------------------- | :------: | ----------------------------------- | | $ref | `string` | **REQUIRED**. The reference string. | This object cannot be extended with additional properties, and any properties added SHALL be ignored. @@ -2617,7 +2617,7 @@ This object cannot be extended with additional properties, and any properties ad ``` ```yaml -$ref: '#/components/schemas/Pet' +$ref: "#/components/schemas/Pet" ``` ##### Relative Schema Document Example @@ -2657,36 +2657,36 @@ Unless stated otherwise, the keyword definitions follow those of JSON Schema and The following keywords are taken directly from the JSON Schema definition and follow the same specifications: -* title -* multipleOf -* maximum -* exclusiveMaximum -* minimum -* exclusiveMinimum -* maxLength -* minLength -* pattern (This string SHOULD be a valid regular expression, according to the [Ecma-262 Edition 5.1 regular expression](https://www.ecma-international.org/ecma-262/5.1/#sec-15.10.1) dialect) -* maxItems -* minItems -* uniqueItems -* maxProperties -* minProperties -* required -* enum +- title +- multipleOf +- maximum +- exclusiveMaximum +- minimum +- exclusiveMinimum +- maxLength +- minLength +- pattern (This string SHOULD be a valid regular expression, according to the [Ecma-262 Edition 5.1 regular expression](https://www.ecma-international.org/ecma-262/5.1/#sec-15.10.1) dialect) +- maxItems +- minItems +- uniqueItems +- maxProperties +- minProperties +- required +- enum The following keywords are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification. -* type - Value MUST be a string. Multiple types via an array are not supported. -* allOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. -* oneOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. -* anyOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. -* not - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. -* items - Value MUST be an object and not an array. Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. `items` MUST be present if `type` is `"array"`. -* properties - Property definitions MUST be a [Schema Object](#schema-object) and not a standard JSON Schema (inline or referenced). -* additionalProperties - Value can be boolean or object. Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. Consistent with JSON Schema, `additionalProperties` defaults to `true`. -* description - [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -* format - See [Data Type Formats](#data-type-format) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats. -* default - The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined `type` for the Schema Object defined at the same level. For example, if `type` is `"string"`, then `default` can be `"foo"` but cannot be `1`. +- type - Value MUST be a string. Multiple types via an array are not supported. +- allOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. +- oneOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. +- anyOf - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. +- not - Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. +- items - Value MUST be an object and not an array. Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. `items` MUST be present if `type` is `"array"`. +- properties - Property definitions MUST be a [Schema Object](#schema-object) and not a standard JSON Schema (inline or referenced). +- additionalProperties - Value can be boolean or object. Inline or referenced schema MUST be of a [Schema Object](#schema-object) and not a standard JSON Schema. Consistent with JSON Schema, `additionalProperties` defaults to `true`. +- description - [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. +- format - See [Data Type Formats](#data-type-format) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats. +- default - The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided. Unlike JSON Schema, the value MUST conform to the defined `type` for the Schema Object defined at the same level. For example, if `type` is `"string"`, then `default` can be `"foo"` but cannot be `1`. Alternatively, any time a Schema Object can be used, a [Reference Object](#reference-object) can be used in its place. This allows referencing definitions instead of defining them inline. @@ -2696,16 +2696,16 @@ Other than the JSON Schema subset fields, the following fields MAY be used for f ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| nullable | `boolean` | This keyword only takes effect if `type` is explicitly defined within the same Schema Object. A `true` value indicates that both `null` values and values of the type specified by `type` are allowed. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of `null` as a value. A `false` value leaves the specified or default `type` unmodified. The default value is `false`. | -| discriminator | [Discriminator Object](#discriminator-object) | Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See [Composition and Inheritance](#composition-and-inheritance-polymorphism) for more details. | -| readOnly | `boolean` | Relevant only for Schema Object `properties` definitions. Declares the property as "read only". 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`. | -| writeOnly | `boolean` | Relevant only for Schema Object `properties` definitions. Declares the property as "write only". 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`. | -| xml | [XML Object](#xml-object) | This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | -| example | Any | A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. | -| deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| Field Name | Type | Description | +| ------------------------------------------------ | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| nullable | `boolean` | This keyword only takes effect if `type` is explicitly defined within the same Schema Object. A `true` value indicates that both `null` values and values of the type specified by `type` are allowed. Other Schema Object constraints retain their defined behavior, and therefore may disallow the use of `null` as a value. A `false` value leaves the specified or default `type` unmodified. The default value is `false`. | +| discriminator | [Discriminator Object](#discriminator-object) | Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See [Composition and Inheritance](#composition-and-inheritance-polymorphism) for more details. | +| readOnly | `boolean` | Relevant only for Schema Object `properties` definitions. Declares the property as "read only". 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`. | +| writeOnly | `boolean` | Relevant only for Schema Object `properties` definitions. Declares the property as "write only". 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`. | +| xml | [XML Object](#xml-object) | This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. | +| deprecated | `boolean` | Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2720,8 +2720,8 @@ When used, the `discriminator` indicates the name of the property that hints whi As such, the `discriminator` field MUST be a required field. There are two ways to define the value of a discriminator for an inheriting instance. -* Use the schema name. -* [Override the schema name](#discriminator-mapping) by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. +- Use the schema name. +- [Override the schema name](#discriminator-mapping) by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. ###### XML Modeling @@ -2774,7 +2774,7 @@ properties: name: type: string address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" age: type: integer format: int32 @@ -2814,7 +2814,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/components/schemas/ComplexModel' + $ref: "#/components/schemas/ComplexModel" ``` ###### Model with Example @@ -2912,7 +2912,7 @@ components: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/components/schemas/ErrorModel' + - $ref: "#/components/schemas/ErrorModel" - type: object required: - rootCause @@ -3006,7 +3006,7 @@ components: Cat: # "Cat" will be used as the discriminating value description: A representation of a cat allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object properties: huntingSkill: @@ -3022,7 +3022,7 @@ components: Dog: # "Dog" will be used as the discriminating value description: A representation of a dog allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object properties: packSize: @@ -3045,10 +3045,10 @@ Note that `discriminator` MUST NOT change the validation outcome of the schema. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminating value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined. | -| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or URI references. | +| Field Name | Type | Description | +| -------------------------------------------- | :---------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminating value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined. | +| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or URI references. | ##### Conditions for Using the Discriminator Object @@ -3085,9 +3085,9 @@ In OAS 3.0, a response payload MAY be described to be exactly one of any number ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" ``` which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. Deserialization of a `oneOf` can be a costly operation, as it requires determining which schema matches the payload and thus should be used in deserialization. This problem also exists for `anyOf` schemas. A `discriminator` MAY be used as a "hint" to improve the efficiency of selection of the matching schema. The `discriminator` field cannot change the validation result of the `oneOf`, it can only help make the deserialization more efficient and provide better error messaging. We can specify the exact field that tells us which schema is expected to match the instance: @@ -3095,9 +3095,9 @@ which means the payload _MUST_, by validation, match exactly one of the schemas ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" discriminator: propertyName: petType ``` @@ -3118,14 +3118,14 @@ In scenarios where the value of the `discriminator` field does not match the sch ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" - $ref: https://gigantic-server.com/schemas/Monster/schema.json discriminator: propertyName: petType mapping: - dog: '#/components/schemas/Dog' + dog: "#/components/schemas/Dog" monster: https://gigantic-server.com/schemas/Monster/schema.json ``` @@ -3151,7 +3151,7 @@ components: dog: Dog Cat: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Cat` properties: @@ -3159,7 +3159,7 @@ components: type: string Dog: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Dog` properties: @@ -3167,7 +3167,7 @@ components: type: string Lizard: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Lizard` properties: @@ -3204,21 +3204,21 @@ See examples for expected behavior. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `"array"` (outside the `items`), it will affect the wrapping element if and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | -| namespace | `string` | The URI of the namespace definition. Value MUST be in the form of a non-relative URI. | -| prefix | `string` | The prefix to be used for the [name](#xml-name). | -| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | -| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `"array"` (outside the `items`). | +| Field Name | Type | Description | +| ------------------------------------- | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `"array"` (outside the `items`), it will affect the wrapping element if and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | The URI of the namespace definition. Value MUST be in the form of a non-relative URI. | +| prefix | `string` | The prefix to be used for the [name](#xml-name). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `"array"` (outside the `items`). | This object MAY be extended with [Specification Extensions](#specification-extensions). The `namespace` field is intended to match the syntax of [XML namespaces](https://www.w3.org/TR/xml-names11/), although there are a few caveats: -* Version 3.0.3 and earlier of this specification erroneously used the term "absolute URI" instead of "non-relative URI", so authors using namespaces that include a fragment should check tooling support carefully. -* XML allows but discourages relative URI-references, while this specification outright forbids them. -* XML 1.1 allows IRIs ([RFC3987](https://datatracker.ietf.org/doc/html/rfc3987)) as namespaces, and specifies that namespaces are compared without any encoding or decoding, which means that IRIs encoded to meet this specification's URI syntax requirement cannot be compared to IRIs as-is. +- Version 3.0.3 and earlier of this specification erroneously used the term "absolute URI" instead of "non-relative URI", so authors using namespaces that include a fragment should check tooling support carefully. +- XML allows but discourages relative URI-references, while this specification outright forbids them. +- XML 1.1 allows IRIs ([RFC3987](https://datatracker.ietf.org/doc/html/rfc3987)) as namespaces, and specifies that namespaces are compared without any encoding or decoding, which means that IRIs encoded to meet this specification's URI syntax requirement cannot be compared to IRIs as-is. ##### XML Object Examples @@ -3564,16 +3564,16 @@ Please note that as of 2020, the implicit flow is about to be deprecated by [OAu ##### Fixed Fields -| Field Name | Type | Applies To | Description | -| ---- | :----: | ---- | ---- | -| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. | -| description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | -| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"`, or `"cookie"`. | -| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authentication scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). The value is case-insensitive, as defined in [RFC7235](https://datatracker.ietf.org/doc/html/rfc7235#section-2.1). | -| bearerFormat | `string` | `http` (`"bearer"`) | 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. | -| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | -| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. [Well-known URL](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) to discover the [[OpenID-Connect-Discovery]] [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------------ | :---------------------------------------: | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"`, or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authentication scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). The value is case-insensitive, as defined in [RFC7235](https://datatracker.ietf.org/doc/html/rfc7235#section-2.1). | +| bearerFormat | `string` | `http` (`"bearer"`) | 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. | +| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. [Well-known URL](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) to discover the [[OpenID-Connect-Discovery]] [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3658,12 +3658,12 @@ Allows configuration of the supported OAuth Flows. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | -| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | +| Field Name | Type | Description | +| -------------------------------------------------------------- | :-------------------------------------: | ---------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | | clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | -| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3673,12 +3673,12 @@ Configuration details for a supported OAuth Flow ##### Fixed Fields -| Field Name | Type | Applies To | Description | -| ---- | :----: | ---- | ---- | -| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | +| Field Name | Type | Applies To | Description | +| ----------------------------------------------------------- | :---------------------: | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3738,8 +3738,8 @@ An empty Security Requirement Object (`{}`) indicates anonymous access is suppor ##### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ----------------------------------------------- | :--------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | {name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#security-scheme-object) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MUST be empty. | ##### Security Requirement Object Examples @@ -3801,9 +3801,9 @@ While the OpenAPI Specification tries to accommodate most use cases, additional The extensions properties are implemented as patterned fields that are always prefixed by `x-`. -| Field Pattern | Type | Description | -| ---- | :--: | ---- | -| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be any valid JSON value (`null`, a primitive, an array, or an object.) | +| Field Pattern | Type | Description | +| --------------------------------- | :--: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. The value can be any valid JSON value (`null`, a primitive, an array, or an object.) | The OpenAPI Initiative maintains several [[OpenAPI-Registry|extension registries]], including registries for [individual extension keywords](https://spec.openapis.org/registry/extension/) and [extension keyword namespaces](https://spec.openapis.org/registry/namespace/). @@ -3830,10 +3830,10 @@ Two examples of this: OpenAPI Descriptions use a combination of JSON, YAML, and JSON Schema, and therefore share their security considerations: -* [JSON](https://www.iana.org/assignments/media-types/application/json) -* [YAML](https://www.iana.org/assignments/media-types/application/yaml) -* [JSON Schema Core](https://tools.ietf.org/html/draft-wright-json-schema-00#section-10) -* [JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-8) +- [JSON](https://www.iana.org/assignments/media-types/application/json) +- [YAML](https://www.iana.org/assignments/media-types/application/yaml) +- [JSON Schema Core](https://tools.ietf.org/html/draft-wright-json-schema-00#section-10) +- [JSON Schema Validation](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-8) ### Tooling and Usage Scenarios @@ -3857,21 +3857,21 @@ Certain fields allow the use of Markdown which can contain HTML including script ## Appendix A: Revision History -| Version | Date | Notes | -| ---- | ---- | ---- | -| 3.0.4 | 2024-10-24 | Patch release of the OpenAPI Specification 3.0.4 | -| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | -| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | -| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | -| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | -| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | -| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | -| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | -| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | -| 2.0 | 2014-09-08 | Release of Swagger 2.0 | -| 1.2 | 2014-03-14 | Initial release of the formal document. | -| 1.1 | 2012-08-22 | Release of Swagger 1.1 | -| 1.0 | 2011-08-10 | First release of the Swagger Specification | +| Version | Date | Notes | +| --------- | ---------- | ------------------------------------------------- | +| 3.0.4 | 2024-10-24 | Patch release of the OpenAPI Specification 3.0.4 | +| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | +| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | +| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | ## Appendix B: Data Type Conversion @@ -3886,8 +3886,8 @@ However, there is no general-purpose specification for converting schema-validat Two cases do offer standards-based guidance: -* [RFC3987](https://datatracker.ietf.org/doc/html/rfc3987#section-3.1) provides guidance for converting non-Unicode strings to UTF-8, particularly in the context of URIs (and by extension, the form media types which use the same encoding rules) -* [RFC6570](https://www.rfc-editor.org/rfc/rfc6570#section-2.3) specifies which values, including but not limited to `null`, are considered _undefined_ and therefore treated specially in the expansion process when serializing based on that specification +- [RFC3987](https://datatracker.ietf.org/doc/html/rfc3987#section-3.1) provides guidance for converting non-Unicode strings to UTF-8, particularly in the context of URIs (and by extension, the form media types which use the same encoding rules) +- [RFC6570](https://www.rfc-editor.org/rfc/rfc6570#section-2.3) specifies which values, including but not limited to `null`, are considered _undefined_ and therefore treated specially in the expansion process when serializing based on that specification Implementations of RFC6570 often have their own conventions for converting non-string values, but these are implementation-specific and not defined by the RFC itself. This is one reason for the OpenAPI Specification to leave these conversions as implementation-defined: It allows using RFC6570 implementations regardless of how they choose to perform the conversions. @@ -3905,11 +3905,11 @@ Requiring input as pre-formatted, schema-validated strings also improves round-t Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in three scenarios: -| Object | Condition | -| ---- | ---- | -| [Parameter Object](#parameter-object) | When `schema` is present | -| [Header Object](#header-object) | When `schema` is present | -| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used | +| Object | Condition | +| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| [Parameter Object](#parameter-object) | When `schema` is present | +| [Header Object](#header-object) | When `schema` is present | +| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used | Implementations of this specification MAY use an implementation of RFC6570 to perform variable expansion, however, some caveats apply. @@ -3922,16 +3922,16 @@ Using an implementation with a lower level of support will require additional ma Certain field values translate to RFC6570 [operators](https://datatracker.ietf.org/doc/html/rfc6570#section-2.2) (or lack thereof): -| field | value | equivalent | -| ---- | ---- | ---- | -| style | `"simple"` | _n/a_ | -| style | `"matrix"` | `;` prefix operator | -| style | `"label"` | `.` prefix operator | -| style | `"form"` | `?` prefix operator | -| allowReserved | `false` | _n/a_ | -| allowReserved | `true` | `+` prefix operator | -| explode | `false` | _n/a_ | -| explode | `true` | `*` modifier suffix | +| field | value | equivalent | +| ------------- | ---------- | ------------------- | +| style | `"simple"` | _n/a_ | +| style | `"matrix"` | `;` prefix operator | +| style | `"label"` | `.` prefix operator | +| style | `"form"` | `?` prefix operator | +| allowReserved | `false` | _n/a_ | +| allowReserved | `true` | `+` prefix operator | +| explode | `false` | _n/a_ | +| explode | `true` | `*` modifier suffix | Multiple `style: "form"` parameters are equivalent to a single RFC6570 [variable list](https://www.rfc-editor.org/rfc/rfc6570#section-2.2) using the `?` prefix operator: @@ -3969,9 +3969,9 @@ Implementations MAY create a properly delimited URI Template with variables for This includes: -* the styles `pipeDelimited`, `spaceDelimited`, and `deepObject`, which have no equivalents at all -* the combination of the style `form` with `allowReserved: true`, which is not allowed because only one prefix operator can be used at a time -* any parameter name that is not a legal RFC6570 variable name +- the styles `pipeDelimited`, `spaceDelimited`, and `deepObject`, which have no equivalents at all +- the combination of the style `form` with `allowReserved: true`, which is not allowed because only one prefix operator can be used at a time +- any parameter name that is not a legal RFC6570 variable name The Parameter Object's `name` field has a much more permissive syntax than RFC6570 [variable name syntax](https://www.rfc-editor.org/rfc/rfc6570#section-2.3). A parameter name that includes characters outside of the allowed RFC6570 variable character set MUST be percent-encoded before it can be used in a URI Template. @@ -4181,9 +4181,9 @@ _**NOTE:** In this section, the `application/x-www-form-urlencoded` and `multipa Percent-encoding is used in URIs and media types that derive their syntax from URIs. This process is concerned with three sets of characters, the names of which vary among specifications but are defined as follows for the purposes of this section: -* _unreserved_ characters do not need to be percent-encoded; while it is safe to percent-encode them, doing so produces a URI that is [not normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.2) -* _reserved_ characters either have special behavior in the URI syntax (such as delimiting components) or are reserved for other specifications that need to define special behavior (e.g. `form-urlencoded` defines special behavior for `=`, `&`, and `+`) -* _unsafe_ characters are known to cause problems when parsing URIs in certain environments +- _unreserved_ characters do not need to be percent-encoded; while it is safe to percent-encode them, doing so produces a URI that is [not normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.2) +- _reserved_ characters either have special behavior in the URI syntax (such as delimiting components) or are reserved for other specifications that need to define special behavior (e.g. `form-urlencoded` defines special behavior for `=`, `&`, and `+`) +- _unsafe_ characters are known to cause problems when parsing URIs in certain environments Unless otherwise specified, this section uses RFC3986's definition of [reserved](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2) and [unreserved](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3), and defines the unsafe set as all characters not included in either of those sets. @@ -4212,11 +4212,11 @@ Unfortunately, these specifications each define slightly different percent-encod This specification normatively cites the following relevant standards: -| Specification | Date | OAS Usage | Percent-Encoding | Notes | -| ---- | ---- | ---- | ---- | ---- | -| [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) | 01/2005 | URI/URL syntax | [[RFC3986]] | obsoletes [[RFC1738]], [[RFC2396]] | -| [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) | 03/2012 | style-based serialization | [[RFC3986]] | does not use `+` for form‑urlencoded | -| [RFC1866](https://datatracker.ietf.org/doc/html/rfc1866#section-8.2.1) | 11/1995 | content-based serialization | [[RFC1738]] | obsoleted by [[HTML401]] [Section 17.13.4.1](https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1), [[URL]] [Section 5](https://url.spec.whatwg.org/#urlencoded-serializing) | +| Specification | Date | OAS Usage | Percent-Encoding | Notes | +| ---------------------------------------------------------------------- | ------- | --------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) | 01/2005 | URI/URL syntax | [[RFC3986]] | obsoletes [[RFC1738]], [[RFC2396]] | +| [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) | 03/2012 | style-based serialization | [[RFC3986]] | does not use `+` for form‑urlencoded | +| [RFC1866](https://datatracker.ietf.org/doc/html/rfc1866#section-8.2.1) | 11/1995 | content-based serialization | [[RFC1738]] | obsoleted by [[HTML401]] [Section 17.13.4.1](https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1), [[URL]] [Section 5](https://url.spec.whatwg.org/#urlencoded-serializing) | Style-based serialization is used in the [Parameter Object](#parameter-object) when `schema` is present, and in the [Encoding Object](#encoding-object) when at least one of `style`, `explode`, or `allowReserved` is present. See [Appendix C](#appendix-c-using-rfc6570-based-serialization) for more details of RFC6570's two different approaches to percent-encoding, including an example involving `+`. @@ -4265,7 +4265,7 @@ This keeps it outside of the processes governed by this specification. ## Appendix F: Resolving Security Requirements in a Referenced Document -This appendix shows how to retrieve an HTTP-accessible multi-document OpenAPI Description (OAD) and resolve a [Security Requirement Object](#security-requirement-object) in the referenced (non-entry) document. See [Resolving Implicit Connections](#resolving-implicit-connections) for more information. +This appendix shows how to retrieve an HTTP-accessible multi-document OpenAPI Description (OAD) and resolve a [Security Requirement Object](#security-requirement-object) in the referenced (non-entry) document. See [Resolving Implicit Connections](#resolving-implicit-connections) for more information. First, the [entry document](#openapi-description-structure) is where parsing begins. It defines the `MySecurity` security scheme to be JWT-based, and it defines a Path Item as a reference to a component in another document: @@ -4307,10 +4307,10 @@ components: bearerFormat: JWT paths: /foo: - $ref: 'other#/components/pathItems/Foo' + $ref: "other#/components/pathItems/Foo" ``` -This entry document references another document, `other`, without using a file extension. This gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available: +This entry document references another document, `other`, without using a file extension. This gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available: ```HTTP GET /api/description/other HTTP/1.1 diff --git a/3.0/components.ts b/3.0/components.ts index 9a7ae87..a21ccb2 100644 --- a/3.0/components.ts +++ b/3.0/components.ts @@ -1,13 +1,5 @@ import type { Extension } from "./extensions"; -import type { - Callback, - Example, - Header, - Link, - Parameter, - RequestBody, - Response, -} from "./paths"; +import type { Callback, Example, Header, Link, Parameter, RequestBody, Response } from "./paths"; import type { Reference } from "./references"; import type { Schema } from "./schema"; import type { SecurityScheme } from "./security"; @@ -68,147 +60,147 @@ import type { SecurityScheme } from "./security"; * ``` */ export interface Components extends Extension { - /** - * An object to hold reusable Schema Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - schemas} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - schemas} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - schemas} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - schemas} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - schemas} | - * @property `schemas` - Optional An object to hold reusable Schema Objects - * - * @example { "User": { type: "object", properties: { id: { type: "integer" } } } } - */ - schemas?: Record; + /** + * An object to hold reusable Schema Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - schemas} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - schemas} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - schemas} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - schemas} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - schemas} | + * @property `schemas` - Optional An object to hold reusable Schema Objects + * + * @example { "User": { type: "object", properties: { id: { type: "integer" } } } } + */ + schemas?: Record; - /** - * An object to hold reusable Response Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - responses} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - responses} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - responses} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - responses} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - responses} | - * @property `responses` - Optional An object to hold reusable Response Objects - * - * @example { "NotFound": { description: "Resource not found" } } - */ - responses?: Record; + /** + * An object to hold reusable Response Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - responses} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - responses} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - responses} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - responses} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - responses} | + * @property `responses` - Optional An object to hold reusable Response Objects + * + * @example { "NotFound": { description: "Resource not found" } } + */ + responses?: Record; - /** - * An object to hold reusable Parameter Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - parameters} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - parameters} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - parameters} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - parameters} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - parameters} | - * @property `parameters` - Optional An object to hold reusable Parameter Objects - * - * @example { "LimitParam": { name: "limit", in: "query", schema: { type: "integer" } } } - */ - parameters?: Record; + /** + * An object to hold reusable Parameter Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - parameters} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - parameters} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - parameters} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - parameters} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - parameters} | + * @property `parameters` - Optional An object to hold reusable Parameter Objects + * + * @example { "LimitParam": { name: "limit", in: "query", schema: { type: "integer" } } } + */ + parameters?: Record; - /** - * An object to hold reusable Example Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - examples} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - examples} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - examples} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - examples} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - examples} | - * @property `examples` - Optional An object to hold reusable Example Objects - * - * @example { "UserExample": { summary: "A user example", value: { id: 1, name: "John" } } } - */ - examples?: Record; + /** + * An object to hold reusable Example Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - examples} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - examples} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - examples} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - examples} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - examples} | + * @property `examples` - Optional An object to hold reusable Example Objects + * + * @example { "UserExample": { summary: "A user example", value: { id: 1, name: "John" } } } + */ + examples?: Record; - /** - * An object to hold reusable Request Body Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - requestBodies} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - requestBodies} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - requestBodies} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - requestBodies} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - requestBodies} | - * @property `requestBodies` - Optional An object to hold reusable Request Body Objects - * - * @example { "UserRequest": { description: "User data", content: { "application/json": { schema: { $ref: "#/components/schemas/User" } } } } } - */ - requestBodies?: Record; + /** + * An object to hold reusable Request Body Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - requestBodies} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - requestBodies} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - requestBodies} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - requestBodies} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - requestBodies} | + * @property `requestBodies` - Optional An object to hold reusable Request Body Objects + * + * @example { "UserRequest": { description: "User data", content: { "application/json": { schema: { $ref: "#/components/schemas/User" } } } } } + */ + requestBodies?: Record; - /** - * An object to hold reusable Header Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - headers} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - headers} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - headers} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - headers} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - headers} | - * @property `headers` - Optional An object to hold reusable Header Objects - * - * @example { "RateLimit": { description: "Rate limit header", schema: { type: "integer" } } } - */ - headers?: Record; + /** + * An object to hold reusable Header Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - headers} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - headers} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - headers} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - headers} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - headers} | + * @property `headers` - Optional An object to hold reusable Header Objects + * + * @example { "RateLimit": { description: "Rate limit header", schema: { type: "integer" } } } + */ + headers?: Record; - /** - * An object to hold reusable Security Scheme Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - securitySchemes} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - securitySchemes} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - securitySchemes} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - securitySchemes} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - securitySchemes} | - * @property `securitySchemes` - Optional An object to hold reusable Security Scheme Objects - * - * @example { "ApiKeyAuth": { type: "apiKey", in: "header", name: "X-API-Key" } } - */ - securitySchemes?: Record; + /** + * An object to hold reusable Security Scheme Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - securitySchemes} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - securitySchemes} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - securitySchemes} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - securitySchemes} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - securitySchemes} | + * @property `securitySchemes` - Optional An object to hold reusable Security Scheme Objects + * + * @example { "ApiKeyAuth": { type: "apiKey", in: "header", name: "X-API-Key" } } + */ + securitySchemes?: Record; - /** - * An object to hold reusable Link Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - links} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - links} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - links} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - links} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - links} | - * @property `links` - Optional An object to hold reusable Link Objects - * - * @example { "UserRepositories": { operationId: "getUserRepositories", parameters: { username: "$response.body#/username" } } } - */ - links?: Record; + /** + * An object to hold reusable Link Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - links} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - links} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - links} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - links} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - links} | + * @property `links` - Optional An object to hold reusable Link Objects + * + * @example { "UserRepositories": { operationId: "getUserRepositories", parameters: { username: "$response.body#/username" } } } + */ + links?: Record; - /** - * An object to hold reusable Callback Objects. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - callbacks} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - callbacks} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - callbacks} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - callbacks} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - callbacks} | - * @property `callbacks` - Optional An object to hold reusable Callback Objects - * - * @example { "MyCallback": { "{$request.body#/callbackUrl}": { post: { requestBody: { $ref: "#/components/requestBodies/SomeRequestBody" } } } } } - */ - callbacks?: Record; + /** + * An object to hold reusable Callback Objects. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object | OpenAPI 3.0.4 Components Object - callbacks} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object | OpenAPI 3.0.3 Components Object - callbacks} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object | OpenAPI 3.0.2 Components Object - callbacks} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object | OpenAPI 3.0.1 Components Object - callbacks} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object | OpenAPI 3.0.0 Components Object - callbacks} | + * @property `callbacks` - Optional An object to hold reusable Callback Objects + * + * @example { "MyCallback": { "{$request.body#/callbackUrl}": { post: { requestBody: { $ref: "#/components/requestBodies/SomeRequestBody" } } } } } + */ + callbacks?: Record; } diff --git a/3.0/data-types/array.ts b/3.0/data-types/array.ts index 69687bd..af814d4 100644 --- a/3.0/data-types/array.ts +++ b/3.0/data-types/array.ts @@ -89,121 +89,121 @@ import type { XML } from "../xml"; * ``` */ export interface ArraySchema extends Extension { - /** - * The type of the schema. Must be "array" for array schemas. - * - * @example "array" - */ - type: "array"; + /** + * The type of the schema. Must be "array" for array schemas. + * + * @example "array" + */ + type: "array"; - /** - * A short title for the schema. - * - * @example "Tags" - * @example "User List" - */ - title?: string; + /** + * A short title for the schema. + * + * @example "Tags" + * @example "User List" + */ + title?: string; - /** - * A short description of the schema. CommonMark syntax MAY be used for rich text representation. - * - * @example "Array of tag strings" - * @example "List of user objects" - */ - description?: string; + /** + * A short description of the schema. CommonMark syntax MAY be used for rich text representation. + * + * @example "Array of tag strings" + * @example "List of user objects" + */ + description?: string; - /** - * The default value for the schema. - * - * @example ["tag1", "tag2"] - * @example [] - */ - default?: unknown[]; + /** + * The default value for the schema. + * + * @example ["tag1", "tag2"] + * @example [] + */ + default?: unknown[]; - /** - * Example value for the schema. - * - * @example ["example1", "example2"] - * @example [1, 2, 3] - */ - example?: unknown[]; + /** + * Example value for the schema. + * + * @example ["example1", "example2"] + * @example [1, 2, 3] + */ + example?: unknown[]; - /** - * Enumeration of valid array values. - * - * @example [["a", "b"], ["c", "d"]] - * @example [[1, 2], [3, 4]] - */ - enum?: unknown[][]; + /** + * Enumeration of valid array values. + * + * @example [["a", "b"], ["c", "d"]] + * @example [[1, 2], [3, 4]] + */ + enum?: unknown[][]; - /** - * Whether the property is read-only. Default value is false. - * - * @default false - * @example true - */ - readOnly?: boolean; + /** + * Whether the property is read-only. Default value is false. + * + * @default false + * @example true + */ + readOnly?: boolean; - /** - * Whether the property is write-only. Default value is false. - * - * @default false - * @example true - */ - writeOnly?: boolean; + /** + * Whether the property is write-only. Default value is false. + * + * @default false + * @example true + */ + writeOnly?: boolean; - /** - * XML representation metadata for the schema. - * - * @example { name: "tags", wrapped: true } - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * + * @example { name: "tags", wrapped: true } + */ + xml?: XML; - /** - * Additional external documentation for the schema. - * - * @example { description: "Find out more about this field", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for the schema. + * + * @example { description: "Find out more about this field", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * Whether the schema is deprecated. Default value is false. - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Whether the schema is deprecated. Default value is false. + * + * @default false + * @example true + */ + deprecated?: boolean; - // Array-specific validation constraints - /** - * Schema for the items in the array. This field is required for array schemas. - * - * @example { type: "string" } - * @example { $ref: "#/components/schemas/User" } - */ - items?: Schema; + // Array-specific validation constraints + /** + * Schema for the items in the array. This field is required for array schemas. + * + * @example { type: "string" } + * @example { $ref: "#/components/schemas/User" } + */ + items?: Schema; - /** - * Maximum number of items in the array. The value MUST be a non-negative integer. - * - * @example 10 - * @example 100 - */ - maxItems?: number; + /** + * Maximum number of items in the array. The value MUST be a non-negative integer. + * + * @example 10 + * @example 100 + */ + maxItems?: number; - /** - * Minimum number of items in the array. The value MUST be a non-negative integer. - * - * @example 1 - * @example 0 - */ - minItems?: number; + /** + * Minimum number of items in the array. The value MUST be a non-negative integer. + * + * @example 1 + * @example 0 + */ + minItems?: number; - /** - * Whether all items in the array must be unique. Default value is false. - * - * @default false - * @example true - */ - uniqueItems?: boolean; + /** + * Whether all items in the array must be unique. Default value is false. + * + * @default false + * @example true + */ + uniqueItems?: boolean; } diff --git a/3.0/data-types/boolean.ts b/3.0/data-types/boolean.ts index 491c416..e906525 100644 --- a/3.0/data-types/boolean.ts +++ b/3.0/data-types/boolean.ts @@ -81,87 +81,87 @@ import type { XML } from "../xml"; * ``` */ export interface BooleanSchema extends Extension { - /** - * The type of the schema. Must be "boolean" for boolean schemas. - * - * @example "boolean" - */ - type: "boolean"; + /** + * The type of the schema. Must be "boolean" for boolean schemas. + * + * @example "boolean" + */ + type: "boolean"; - /** - * A short title for the schema. - * - * @example "Is Active" - * @example "Enabled" - */ - title?: string; + /** + * A short title for the schema. + * + * @example "Is Active" + * @example "Enabled" + */ + title?: string; - /** - * A short description of the schema. CommonMark syntax MAY be used for rich text representation. - * - * @example "Whether the user is active" - * @example "Feature enabled status" - */ - description?: string; + /** + * A short description of the schema. CommonMark syntax MAY be used for rich text representation. + * + * @example "Whether the user is active" + * @example "Feature enabled status" + */ + description?: string; - /** - * The default value for the schema. - * - * @example true - * @example false - */ - default?: boolean; + /** + * The default value for the schema. + * + * @example true + * @example false + */ + default?: boolean; - /** - * Example value for the schema. - * - * @example true - * @example false - */ - example?: boolean; + /** + * Example value for the schema. + * + * @example true + * @example false + */ + example?: boolean; - /** - * Enumeration of valid boolean values. - * - * @example [true, false] - */ - enum?: boolean[]; + /** + * Enumeration of valid boolean values. + * + * @example [true, false] + */ + enum?: boolean[]; - /** - * Whether the property is read-only. Default value is false. - * - * @default false - * @example true - */ - readOnly?: boolean; + /** + * Whether the property is read-only. Default value is false. + * + * @default false + * @example true + */ + readOnly?: boolean; - /** - * Whether the property is write-only. Default value is false. - * - * @default false - * @example true - */ - writeOnly?: boolean; + /** + * Whether the property is write-only. Default value is false. + * + * @default false + * @example true + */ + writeOnly?: boolean; - /** - * XML representation metadata for the schema. - * - * @example { name: "isActive", attribute: true } - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * + * @example { name: "isActive", attribute: true } + */ + xml?: XML; - /** - * Additional external documentation for the schema. - * - * @example { description: "Find out more about this field", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for the schema. + * + * @example { description: "Find out more about this field", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * Whether the schema is deprecated. Default value is false. - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Whether the schema is deprecated. Default value is false. + * + * @default false + * @example true + */ + deprecated?: boolean; } diff --git a/3.0/data-types/composition.ts b/3.0/data-types/composition.ts index 77d6439..d41d260 100644 --- a/3.0/data-types/composition.ts +++ b/3.0/data-types/composition.ts @@ -92,119 +92,119 @@ import type { XML } from "../xml"; * ``` */ export interface CompositionSchema extends Extension { - /** - * A short title for the schema. - * - * @example "Composed User" - * @example "Flexible Value" - */ - title?: string; + /** + * A short title for the schema. + * + * @example "Composed User" + * @example "Flexible Value" + */ + title?: string; - /** - * A short description of the schema. CommonMark syntax MAY be used for rich text representation. - * - * @example "Schema composed from multiple base schemas" - * @example "Value that can be string or number" - */ - description?: string; + /** + * A short description of the schema. CommonMark syntax MAY be used for rich text representation. + * + * @example "Schema composed from multiple base schemas" + * @example "Value that can be string or number" + */ + description?: string; - /** - * The default value for the schema. - * - * @example "default value" - * @example { name: "default" } - */ - default?: unknown; + /** + * The default value for the schema. + * + * @example "default value" + * @example { name: "default" } + */ + default?: unknown; - /** - * Example value for the schema. - * - * @example "example value" - * @example { name: "example" } - */ - example?: unknown; + /** + * Example value for the schema. + * + * @example "example value" + * @example { name: "example" } + */ + example?: unknown; - /** - * Enumeration of valid values. - * - * @example ["value1", "value2"] - * @example [1, 2, 3] - */ - enum?: unknown[]; + /** + * Enumeration of valid values. + * + * @example ["value1", "value2"] + * @example [1, 2, 3] + */ + enum?: unknown[]; - /** - * Whether the property is read-only. Default value is false. - * - * @default false - * @example true - */ - readOnly?: boolean; + /** + * Whether the property is read-only. Default value is false. + * + * @default false + * @example true + */ + readOnly?: boolean; - /** - * Whether the property is write-only. Default value is false. - * - * @default false - * @example true - */ - writeOnly?: boolean; + /** + * Whether the property is write-only. Default value is false. + * + * @default false + * @example true + */ + writeOnly?: boolean; - /** - * XML representation metadata for the schema. - * - * @example { name: "composed", wrapped: true } - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * + * @example { name: "composed", wrapped: true } + */ + xml?: XML; - /** - * Additional external documentation for the schema. - * - * @example { description: "Find out more about this schema", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for the schema. + * + * @example { description: "Find out more about this schema", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * Whether the schema is deprecated. Default value is false. - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Whether the schema is deprecated. Default value is false. + * + * @default false + * @example true + */ + deprecated?: boolean; - /** - * Discriminator for polymorphism. The property name used to differentiate between schemas. - * - * @example "petType" - * @example "type" - */ - discriminator?: Discriminator; + /** + * Discriminator for polymorphism. The property name used to differentiate between schemas. + * + * @example "petType" + * @example "type" + */ + discriminator?: Discriminator; - // Composition keywords (mutually exclusive) - /** - * Array of schemas that must all be valid for the instance to be valid. - * - * @example [{ $ref: "#/components/schemas/Base" }, { type: "object", required: ["id"] }] - */ - allOf?: Schema[]; + // Composition keywords (mutually exclusive) + /** + * Array of schemas that must all be valid for the instance to be valid. + * + * @example [{ $ref: "#/components/schemas/Base" }, { type: "object", required: ["id"] }] + */ + allOf?: Schema[]; - /** - * Array of schemas where at least one must be valid for the instance to be valid. - * - * @example [{ type: "string" }, { type: "integer" }] - */ - anyOf?: Schema[]; + /** + * Array of schemas where at least one must be valid for the instance to be valid. + * + * @example [{ type: "string" }, { type: "integer" }] + */ + anyOf?: Schema[]; - /** - * Array of schemas where exactly one must be valid for the instance to be valid. - * - * @example [{ $ref: "#/components/schemas/Dog" }, { $ref: "#/components/schemas/Cat" }] - */ - oneOf?: Schema[]; + /** + * Array of schemas where exactly one must be valid for the instance to be valid. + * + * @example [{ $ref: "#/components/schemas/Dog" }, { $ref: "#/components/schemas/Cat" }] + */ + oneOf?: Schema[]; - /** - * Schema that must not be valid for the instance to be valid. - * - * @example { type: "null" } - * @example { type: "string", maxLength: 0 } - */ - not?: Schema; + /** + * Schema that must not be valid for the instance to be valid. + * + * @example { type: "null" } + * @example { type: "string", maxLength: 0 } + */ + not?: Schema; } diff --git a/3.0/data-types/integer.ts b/3.0/data-types/integer.ts index 52ca0be..53a9626 100644 --- a/3.0/data-types/integer.ts +++ b/3.0/data-types/integer.ts @@ -87,139 +87,139 @@ import type { XML } from "../xml"; * ``` */ export interface IntegerSchema extends Extension { - /** - * The type of the schema. Must be "integer" for integer schemas. - * - * @example "integer" - */ - type: "integer"; + /** + * The type of the schema. Must be "integer" for integer schemas. + * + * @example "integer" + */ + type: "integer"; - /** - * The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details. - * - * @example "int32" - * @example "int64" - */ - format?: string; + /** + * The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details. + * + * @example "int32" + * @example "int64" + */ + format?: string; - /** - * A short title for the schema. - * - * @example "User ID" - * @example "Age" - */ - title?: string; + /** + * A short title for the schema. + * + * @example "User ID" + * @example "Age" + */ + title?: string; - /** - * A short description of the schema. CommonMark syntax MAY be used for rich text representation. - * - * @example "The user's unique identifier" - * @example "Age in years" - */ - description?: string; + /** + * A short description of the schema. CommonMark syntax MAY be used for rich text representation. + * + * @example "The user's unique identifier" + * @example "Age in years" + */ + description?: string; - /** - * The default value for the schema. - * - * @example 0 - * @example 1 - */ - default?: number; + /** + * The default value for the schema. + * + * @example 0 + * @example 1 + */ + default?: number; - /** - * Example value for the schema. - * - * @example 42 - * @example 100 - */ - example?: number; + /** + * Example value for the schema. + * + * @example 42 + * @example 100 + */ + example?: number; - /** - * Enumeration of valid integer values. - * - * @example [1, 2, 3, 4, 5] - * @example [0, 1, 2] - */ - enum?: number[]; + /** + * Enumeration of valid integer values. + * + * @example [1, 2, 3, 4, 5] + * @example [0, 1, 2] + */ + enum?: number[]; - /** - * Whether the property is read-only. Default value is false. - * - * @default false - * @example true - */ - readOnly?: boolean; + /** + * Whether the property is read-only. Default value is false. + * + * @default false + * @example true + */ + readOnly?: boolean; - /** - * Whether the property is write-only. Default value is false. - * - * @default false - * @example true - */ - writeOnly?: boolean; + /** + * Whether the property is write-only. Default value is false. + * + * @default false + * @example true + */ + writeOnly?: boolean; - /** - * XML representation metadata for the schema. - * - * @example { name: "userId", attribute: true } - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * + * @example { name: "userId", attribute: true } + */ + xml?: XML; - /** - * Additional external documentation for the schema. - * - * @example { description: "Find out more about this field", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for the schema. + * + * @example { description: "Find out more about this field", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * Whether the schema is deprecated. Default value is false. - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Whether the schema is deprecated. Default value is false. + * + * @default false + * @example true + */ + deprecated?: boolean; - // Integer-specific validation constraints - /** - * A number is valid against "multipleOf" if the result of the division - * of the instance by this keyword's value is an integer. - * - * @example 1 - * @example 2 - * @example 5 - */ - multipleOf?: number; + // Integer-specific validation constraints + /** + * A number is valid against "multipleOf" if the result of the division + * of the instance by this keyword's value is an integer. + * + * @example 1 + * @example 2 + * @example 5 + */ + multipleOf?: number; - /** - * A number is valid against "maximum" if it is less than or equal to this value. - * - * @example 100 - * @example 2147483647 - */ - maximum?: number; + /** + * A number is valid against "maximum" if it is less than or equal to this value. + * + * @example 100 + * @example 2147483647 + */ + maximum?: number; - /** - * A number is valid against "exclusiveMaximum" if it is strictly less than this value. - * - * @example 100 - * @example 1000 - */ - exclusiveMaximum?: number; + /** + * A number is valid against "exclusiveMaximum" if it is strictly less than this value. + * + * @example 100 + * @example 1000 + */ + exclusiveMaximum?: number; - /** - * A number is valid against "minimum" if it is greater than or equal to this value. - * - * @example 0 - * @example 1 - */ - minimum?: number; + /** + * A number is valid against "minimum" if it is greater than or equal to this value. + * + * @example 0 + * @example 1 + */ + minimum?: number; - /** - * A number is valid against "exclusiveMinimum" if it is strictly greater than this value. - * - * @example 0 - * @example -1 - */ - exclusiveMinimum?: number; + /** + * A number is valid against "exclusiveMinimum" if it is strictly greater than this value. + * + * @example 0 + * @example -1 + */ + exclusiveMinimum?: number; } diff --git a/3.0/data-types/number.ts b/3.0/data-types/number.ts index 5e9382e..12dedc8 100644 --- a/3.0/data-types/number.ts +++ b/3.0/data-types/number.ts @@ -89,139 +89,139 @@ import type { XML } from "../xml"; * ``` */ export interface NumberSchema extends Extension { - /** - * The type of the schema. Must be "number" for number schemas. - * - * @example "number" - */ - type: "number"; + /** + * The type of the schema. Must be "number" for number schemas. + * + * @example "number" + */ + type: "number"; - /** - * The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details. - * - * @example "float" - * @example "double" - */ - format?: string; + /** + * The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details. + * + * @example "float" + * @example "double" + */ + format?: string; - /** - * A short title for the schema. - * - * @example "Price" - * @example "Temperature" - */ - title?: string; + /** + * A short title for the schema. + * + * @example "Price" + * @example "Temperature" + */ + title?: string; - /** - * A short description of the schema. CommonMark syntax MAY be used for rich text representation. - * - * @example "The price in dollars" - * @example "Temperature in Celsius" - */ - description?: string; + /** + * A short description of the schema. CommonMark syntax MAY be used for rich text representation. + * + * @example "The price in dollars" + * @example "Temperature in Celsius" + */ + description?: string; - /** - * The default value for the schema. - * - * @example 0 - * @example 25.5 - */ - default?: number; + /** + * The default value for the schema. + * + * @example 0 + * @example 25.5 + */ + default?: number; - /** - * Example value for the schema. - * - * @example 19.99 - * @example 98.6 - */ - example?: number; + /** + * Example value for the schema. + * + * @example 19.99 + * @example 98.6 + */ + example?: number; - /** - * Enumeration of valid number values. - * - * @example [1.0, 2.0, 3.0, 4.0, 5.0] - * @example [0.0, 0.5, 1.0] - */ - enum?: number[]; + /** + * Enumeration of valid number values. + * + * @example [1.0, 2.0, 3.0, 4.0, 5.0] + * @example [0.0, 0.5, 1.0] + */ + enum?: number[]; - /** - * Whether the property is read-only. Default value is false. - * - * @default false - * @example true - */ - readOnly?: boolean; + /** + * Whether the property is read-only. Default value is false. + * + * @default false + * @example true + */ + readOnly?: boolean; - /** - * Whether the property is write-only. Default value is false. - * - * @default false - * @example true - */ - writeOnly?: boolean; + /** + * Whether the property is write-only. Default value is false. + * + * @default false + * @example true + */ + writeOnly?: boolean; - /** - * XML representation metadata for the schema. - * - * @example { name: "price", attribute: true } - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * + * @example { name: "price", attribute: true } + */ + xml?: XML; - /** - * Additional external documentation for the schema. - * - * @example { description: "Find out more about this field", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for the schema. + * + * @example { description: "Find out more about this field", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * Whether the schema is deprecated. Default value is false. - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Whether the schema is deprecated. Default value is false. + * + * @default false + * @example true + */ + deprecated?: boolean; - // Number-specific validation constraints - /** - * A number is valid against "multipleOf" if the result of the division - * of the instance by this keyword's value is an integer. - * - * @example 0.01 - * @example 0.1 - * @example 2 - */ - multipleOf?: number; + // Number-specific validation constraints + /** + * A number is valid against "multipleOf" if the result of the division + * of the instance by this keyword's value is an integer. + * + * @example 0.01 + * @example 0.1 + * @example 2 + */ + multipleOf?: number; - /** - * A number is valid against "maximum" if it is less than or equal to this value. - * - * @example 100 - * @example 999.99 - */ - maximum?: number; + /** + * A number is valid against "maximum" if it is less than or equal to this value. + * + * @example 100 + * @example 999.99 + */ + maximum?: number; - /** - * A number is valid against "exclusiveMaximum" if it is strictly less than this value. - * - * @example 100 - * @example 1000 - */ - exclusiveMaximum?: number; + /** + * A number is valid against "exclusiveMaximum" if it is strictly less than this value. + * + * @example 100 + * @example 1000 + */ + exclusiveMaximum?: number; - /** - * A number is valid against "minimum" if it is greater than or equal to this value. - * - * @example 0 - * @example -273.15 - */ - minimum?: number; + /** + * A number is valid against "minimum" if it is greater than or equal to this value. + * + * @example 0 + * @example -273.15 + */ + minimum?: number; - /** - * A number is valid against "exclusiveMinimum" if it is strictly greater than this value. - * - * @example 0 - * @example -100 - */ - exclusiveMinimum?: number; + /** + * A number is valid against "exclusiveMinimum" if it is strictly greater than this value. + * + * @example 0 + * @example -100 + */ + exclusiveMinimum?: number; } diff --git a/3.0/data-types/object.ts b/3.0/data-types/object.ts index 6e3594e..52d4d76 100644 --- a/3.0/data-types/object.ts +++ b/3.0/data-types/object.ts @@ -106,154 +106,154 @@ import type { XML } from "../xml"; * ``` */ export interface ObjectSchema extends Extension { - /** - * The type of the schema. Must be "object" for object schemas. - * - * @example "object" - */ - type: "object"; + /** + * The type of the schema. Must be "object" for object schemas. + * + * @example "object" + */ + type: "object"; - /** - * A short title for the schema. - * - * @example "User" - * @example "Product" - */ - title?: string; + /** + * A short title for the schema. + * + * @example "User" + * @example "Product" + */ + title?: string; - /** - * A short description of the schema. CommonMark syntax MAY be used for rich text representation. - * - * @example "A user object containing basic information" - * @example "Product information with pricing" - */ - description?: string; + /** + * A short description of the schema. CommonMark syntax MAY be used for rich text representation. + * + * @example "A user object containing basic information" + * @example "Product information with pricing" + */ + description?: string; - /** - * The default value for the schema. - * - * @example { name: "John", age: 30 } - * @example {} - */ - default?: Record; + /** + * The default value for the schema. + * + * @example { name: "John", age: 30 } + * @example {} + */ + default?: Record; - /** - * Example value for the schema. - * - * @example { name: "Jane", age: 25 } - * @example { id: 1, title: "Sample" } - */ - example?: Record; + /** + * Example value for the schema. + * + * @example { name: "Jane", age: 25 } + * @example { id: 1, title: "Sample" } + */ + example?: Record; - /** - * Enumeration of valid object values. - * - * @example [{ name: "John" }, { name: "Jane" }] - * @example [{ status: "active" }, { status: "inactive" }] - */ - enum?: Record[]; + /** + * Enumeration of valid object values. + * + * @example [{ name: "John" }, { name: "Jane" }] + * @example [{ status: "active" }, { status: "inactive" }] + */ + enum?: Record[]; - /** - * Whether the property is read-only. Default value is false. - * - * @default false - * @example true - */ - readOnly?: boolean; + /** + * Whether the property is read-only. Default value is false. + * + * @default false + * @example true + */ + readOnly?: boolean; - /** - * Whether the property is write-only. Default value is false. - * - * @default false - * @example true - */ - writeOnly?: boolean; + /** + * Whether the property is write-only. Default value is false. + * + * @default false + * @example true + */ + writeOnly?: boolean; - /** - * XML representation metadata for the schema. - * - * @example { name: "user", wrapped: false } - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * + * @example { name: "user", wrapped: false } + */ + xml?: XML; - /** - * Additional external documentation for the schema. - * - * @example { description: "Find out more about this object", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for the schema. + * + * @example { description: "Find out more about this object", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * Whether the schema is deprecated. Default value is false. - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Whether the schema is deprecated. Default value is false. + * + * @default false + * @example true + */ + deprecated?: boolean; - /** - * Discriminator for polymorphism. The property name used to differentiate between schemas. - * - * @example "petType" - * @example "type" - */ - discriminator?: Discriminator; + /** + * Discriminator for polymorphism. The property name used to differentiate between schemas. + * + * @example "petType" + * @example "type" + */ + discriminator?: Discriminator; - // Object-specific validation constraints - /** - * Properties of the object. Each property name maps to a schema definition. - * - * @example { name: { type: "string" }, age: { type: "integer" } } - * @example { id: { $ref: "#/components/schemas/Id" } } - */ - properties?: Record; + // Object-specific validation constraints + /** + * Properties of the object. Each property name maps to a schema definition. + * + * @example { name: { type: "string" }, age: { type: "integer" } } + * @example { id: { $ref: "#/components/schemas/Id" } } + */ + properties?: Record; - /** - * Array of property names that are required. Properties not listed here are optional. - * - * @example ["id", "name"] - * @example ["email"] - */ - required?: string[]; + /** + * Array of property names that are required. Properties not listed here are optional. + * + * @example ["id", "name"] + * @example ["email"] + */ + required?: string[]; - /** - * Schema for additional properties not defined in the properties object. - * Can be a boolean or a schema. - * - * @example true - * @example false - * @example { type: "string" } - */ - additionalProperties?: boolean | Schema; + /** + * Schema for additional properties not defined in the properties object. + * Can be a boolean or a schema. + * + * @example true + * @example false + * @example { type: "string" } + */ + additionalProperties?: boolean | Schema; - /** - * Pattern-based properties using regular expressions as keys. - * - * @example { "^S_": { type: "string" } } - * @example { "^[0-9]+$": { type: "integer" } } - */ - patternProperties?: Record; + /** + * Pattern-based properties using regular expressions as keys. + * + * @example { "^S_": { type: "string" } } + * @example { "^[0-9]+$": { type: "integer" } } + */ + patternProperties?: Record; - /** - * Schema for property names. If present, property names must conform to this schema. - * - * @example { type: "string", pattern: "^[a-zA-Z][a-zA-Z0-9]*$" } - */ - propertyNames?: Schema; + /** + * Schema for property names. If present, property names must conform to this schema. + * + * @example { type: "string", pattern: "^[a-zA-Z][a-zA-Z0-9]*$" } + */ + propertyNames?: Schema; - /** - * Maximum number of properties in the object. The value MUST be a non-negative integer. - * - * @example 10 - * @example 50 - */ - maxProperties?: number; + /** + * Maximum number of properties in the object. The value MUST be a non-negative integer. + * + * @example 10 + * @example 50 + */ + maxProperties?: number; - /** - * Minimum number of properties in the object. The value MUST be a non-negative integer. - * - * @example 1 - * @example 2 - */ - minProperties?: number; + /** + * Minimum number of properties in the object. The value MUST be a non-negative integer. + * + * @example 1 + * @example 2 + */ + minProperties?: number; } diff --git a/3.0/data-types/reference.ts b/3.0/data-types/reference.ts index 8777a95..abc7f6f 100644 --- a/3.0/data-types/reference.ts +++ b/3.0/data-types/reference.ts @@ -61,20 +61,20 @@ import type { Extension } from "../extensions"; * ``` */ export interface ReferenceSchema extends Extension { - /** - * The reference string. MUST be a valid JSON Reference. - * - * @example "#/components/schemas/User" - * @example "#/components/responses/NotFound" - * @example "#/components/parameters/LimitParam" - */ - $ref: string; + /** + * The reference string. MUST be a valid JSON Reference. + * + * @example "#/components/schemas/User" + * @example "#/components/responses/NotFound" + * @example "#/components/parameters/LimitParam" + */ + $ref: string; - /** - * A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation. - * - * @example "A reference to the User schema" - * @example "Pet object definition" - */ - description?: string; + /** + * A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation. + * + * @example "A reference to the User schema" + * @example "Pet object definition" + */ + description?: string; } diff --git a/3.0/data-types/string.ts b/3.0/data-types/string.ts index 13a483b..0c8a316 100644 --- a/3.0/data-types/string.ts +++ b/3.0/data-types/string.ts @@ -87,258 +87,258 @@ import type { XML } from "../xml"; * ``` */ export interface StringSchema extends Extension { - /** - * The type of the schema. Must be "string" for string schemas. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - type} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - type} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - type} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - type} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - type} | - * @property `type` - Required The type of the schema - * - * @example "string" - */ - type: "string"; + /** + * The type of the schema. Must be "string" for string schemas. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - type} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - type} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - type} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - type} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - type} | + * @property `type` - Required The type of the schema + * + * @example "string" + */ + type: "string"; - /** - * The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - format} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - format} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - format} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - format} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - format} | - * @property `format` - Optional The extending format for the string type - * - * @example "email" - * @example "date" - * @example "uuid" - * @example "uri" - */ - format?: string; + /** + * The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - format} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - format} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - format} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - format} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - format} | + * @property `format` - Optional The extending format for the string type + * + * @example "email" + * @example "date" + * @example "uuid" + * @example "uri" + */ + format?: string; - /** - * A short title for the schema. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - title} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - title} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - title} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - title} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - title} | - * @property `title` - Optional A short title for the schema - * - * @example "User Name" - * @example "Email Address" - */ - title?: string; + /** + * A short title for the schema. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - title} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - title} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - title} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - title} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - title} | + * @property `title` - Optional A short title for the schema + * + * @example "User Name" + * @example "Email Address" + */ + title?: string; - /** - * A short description of the schema. CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - description} | - * @property `description` - Optional A short description of the schema - * - * @example "The user's full name" - * @example "Email address in RFC 5322 format" - */ - description?: string; + /** + * A short description of the schema. CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - description} | + * @property `description` - Optional A short description of the schema + * + * @example "The user's full name" + * @example "Email address in RFC 5322 format" + */ + description?: string; - /** - * The default value for the schema. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - default} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - default} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - default} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - default} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - default} | - * @property `default` - Optional The default value for the schema - * - * @example "John Doe" - * @example "user@example.com" - */ - default?: string; + /** + * The default value for the schema. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - default} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - default} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - default} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - default} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - default} | + * @property `default` - Optional The default value for the schema + * + * @example "John Doe" + * @example "user@example.com" + */ + default?: string; - /** - * Example value for the schema. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - example} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - example} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - example} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - example} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - example} | - * @property `example` - Optional Example value for the schema - * - * @example "Jane Smith" - * @example "admin@example.com" - */ - example?: string; + /** + * Example value for the schema. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - example} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - example} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - example} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - example} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - example} | + * @property `example` - Optional Example value for the schema + * + * @example "Jane Smith" + * @example "admin@example.com" + */ + example?: string; - /** - * Enumeration of valid string values. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - enum} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - enum} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - enum} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - enum} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - enum} | - * @property `enum` - Optional Enumeration of valid string values - * - * @example ["active", "inactive", "pending"] - * @example ["red", "green", "blue"] - */ - enum?: string[]; + /** + * Enumeration of valid string values. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - enum} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - enum} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - enum} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - enum} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - enum} | + * @property `enum` - Optional Enumeration of valid string values + * + * @example ["active", "inactive", "pending"] + * @example ["red", "green", "blue"] + */ + enum?: string[]; - /** - * Whether the property is read-only. Default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - readOnly} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - readOnly} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - readOnly} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - readOnly} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - readOnly} | - * @property `readOnly` - Optional Whether the property is read-only - * - * @default false - * @example true - */ - readOnly?: boolean; + /** + * Whether the property is read-only. Default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - readOnly} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - readOnly} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - readOnly} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - readOnly} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - readOnly} | + * @property `readOnly` - Optional Whether the property is read-only + * + * @default false + * @example true + */ + readOnly?: boolean; - /** - * Whether the property is write-only. Default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - writeOnly} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - writeOnly} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - writeOnly} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - writeOnly} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - writeOnly} | - * @property `writeOnly` - Optional Whether the property is write-only - * - * @default false - * @example true - */ - writeOnly?: boolean; + /** + * Whether the property is write-only. Default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - writeOnly} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - writeOnly} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - writeOnly} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - writeOnly} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - writeOnly} | + * @property `writeOnly` - Optional Whether the property is write-only + * + * @default false + * @example true + */ + writeOnly?: boolean; - /** - * XML representation metadata for the schema. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - xml} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - xml} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - xml} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - xml} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - xml} | - * @property `xml` - Optional XML representation metadata for the schema - * - * @example { name: "userName", attribute: false } - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - xml} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - xml} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - xml} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - xml} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - xml} | + * @property `xml` - Optional XML representation metadata for the schema + * + * @example { name: "userName", attribute: false } + */ + xml?: XML; - /** - * Additional external documentation for the schema. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - externalDocs} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - externalDocs} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - externalDocs} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - externalDocs} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - externalDocs} | - * @property `externalDocs` - Optional Additional external documentation for the schema - * - * @example { description: "Find out more about this field", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for the schema. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - externalDocs} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - externalDocs} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - externalDocs} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - externalDocs} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - externalDocs} | + * @property `externalDocs` - Optional Additional external documentation for the schema + * + * @example { description: "Find out more about this field", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * Whether the schema is deprecated. Default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - deprecated} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - deprecated} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - deprecated} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - deprecated} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - deprecated} | - * @property `deprecated` - Optional Whether the schema is deprecated - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Whether the schema is deprecated. Default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - deprecated} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - deprecated} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - deprecated} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - deprecated} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - deprecated} | + * @property `deprecated` - Optional Whether the schema is deprecated + * + * @default false + * @example true + */ + deprecated?: boolean; - // String-specific validation constraints - /** - * Maximum length of the string. The value MUST be a non-negative integer. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - maxLength} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - maxLength} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - maxLength} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - maxLength} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - maxLength} | - * @property `maxLength` - Optional Maximum length of the string - * - * @example 100 - * @example 255 - */ - maxLength?: number; + // String-specific validation constraints + /** + * Maximum length of the string. The value MUST be a non-negative integer. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - maxLength} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - maxLength} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - maxLength} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - maxLength} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - maxLength} | + * @property `maxLength` - Optional Maximum length of the string + * + * @example 100 + * @example 255 + */ + maxLength?: number; - /** - * Minimum length of the string. The value MUST be a non-negative integer. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - minLength} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - minLength} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - minLength} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - minLength} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - minLength} | - * @property `minLength` - Optional Minimum length of the string - * - * @example 1 - * @example 8 - */ - minLength?: number; + /** + * Minimum length of the string. The value MUST be a non-negative integer. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - minLength} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - minLength} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - minLength} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - minLength} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - minLength} | + * @property `minLength` - Optional Minimum length of the string + * + * @example 1 + * @example 8 + */ + minLength?: number; - /** - * Regular expression pattern the string must match. The pattern MUST be a valid regular expression. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - pattern} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - pattern} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - pattern} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - pattern} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - pattern} | - * @property `pattern` - Optional Regular expression pattern the string must match - * - * @example "^[a-zA-Z0-9]+$" - * @example "^\\d{4}-\\d{2}-\\d{2}$" - */ - pattern?: string; + /** + * Regular expression pattern the string must match. The pattern MUST be a valid regular expression. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object | OpenAPI 3.0.4 Schema Object - pattern} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object | OpenAPI 3.0.3 Schema Object - pattern} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object | OpenAPI 3.0.2 Schema Object - pattern} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object | OpenAPI 3.0.1 Schema Object - pattern} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object | OpenAPI 3.0.0 Schema Object - pattern} | + * @property `pattern` - Optional Regular expression pattern the string must match + * + * @example "^[a-zA-Z0-9]+$" + * @example "^\\d{4}-\\d{2}-\\d{2}$" + */ + pattern?: string; } diff --git a/3.0/extensions.ts b/3.0/extensions.ts index 9eb4114..26d65a0 100644 --- a/3.0/extensions.ts +++ b/3.0/extensions.ts @@ -43,5 +43,5 @@ * ``` */ export type Extension = { - [K in `x-${string}`]: unknown; + [K in `x-${string}`]: unknown; }; diff --git a/3.0/externalDocs.ts b/3.0/externalDocs.ts index e721ba3..2ff325c 100644 --- a/3.0/externalDocs.ts +++ b/3.0/externalDocs.ts @@ -39,37 +39,37 @@ import type { Extension } from "./extensions"; * ``` */ export interface ExternalDocumentation extends Extension { - /** - * A short description of the target documentation. CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object | OpenAPI 3.0.4 External Documentation Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object | OpenAPI 3.0.3 External Documentation Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object | OpenAPI 3.0.2 External Documentation Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object | OpenAPI 3.0.1 External Documentation Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object | OpenAPI 3.0.0 External Documentation Object - description} | - * @property `description` - Optional A short description of the target documentation - * - * @example "Find more info here" - * @example "Additional documentation for this API" - */ - description?: string; + /** + * A short description of the target documentation. CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object | OpenAPI 3.0.4 External Documentation Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object | OpenAPI 3.0.3 External Documentation Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object | OpenAPI 3.0.2 External Documentation Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object | OpenAPI 3.0.1 External Documentation Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object | OpenAPI 3.0.0 External Documentation Object - description} | + * @property `description` - Optional A short description of the target documentation + * + * @example "Find more info here" + * @example "Additional documentation for this API" + */ + description?: string; - /** - * The URL for the target documentation. MUST be in the format of a URL. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object | OpenAPI 3.0.4 External Documentation Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object | OpenAPI 3.0.3 External Documentation Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object | OpenAPI 3.0.2 External Documentation Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object | OpenAPI 3.0.1 External Documentation Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object | OpenAPI 3.0.0 External Documentation Object - url} | - * @property `url` - Required The URL for the target documentation - * - * @example "https://example.com/docs" - * @example "https://api.example.com/documentation" - */ - url: string; + /** + * The URL for the target documentation. MUST be in the format of a URL. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object | OpenAPI 3.0.4 External Documentation Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object | OpenAPI 3.0.3 External Documentation Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object | OpenAPI 3.0.2 External Documentation Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object | OpenAPI 3.0.1 External Documentation Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object | OpenAPI 3.0.0 External Documentation Object - url} | + * @property `url` - Required The URL for the target documentation + * + * @example "https://example.com/docs" + * @example "https://api.example.com/documentation" + */ + url: string; } diff --git a/3.0/index.ts b/3.0/index.ts index 590f451..88d57a8 100644 --- a/3.0/index.ts +++ b/3.0/index.ts @@ -2,64 +2,64 @@ // This file serves as the main entry point for all OpenAPI 3.0 type definitions export type { - // Components types - Components, + // Components types + Components, } from "./components"; // Re-export all types for convenience export type { - // Core types - Extension, + // Core types + Extension, } from "./extensions"; export type { ExternalDocumentation } from "./externalDocs"; export type { - Contact, - // Info types - Info, - License, + Contact, + // Info types + Info, + License, } from "./info"; export type { - Callback, - Encoding, - Example, - Header, - Link, - MediaType, - Operation, - Parameter, - PathItem, - // Path types - Paths, - RequestBody, - Response, + Callback, + Encoding, + Example, + Header, + Link, + MediaType, + Operation, + Parameter, + PathItem, + // Path types + Paths, + RequestBody, + Response, } from "./paths"; export type { Reference } from "./references"; export type { - Discriminator, - // Schema types - Schema, + Discriminator, + // Schema types + Schema, } from "./schema"; export type { - OAuthFlow, - OAuthFlows, - SecurityRequirement, - // Security types - SecurityScheme, + OAuthFlow, + OAuthFlows, + SecurityRequirement, + // Security types + SecurityScheme, } from "./security"; export type { - // Server types - Server, - ServerVariable, + // Server types + Server, + ServerVariable, } from "./servers"; // Export the main specification type export type { Specification } from "./spec"; export type { - // Utility types - Tag, + // Utility types + Tag, } from "./tags"; export type { - // XML types - XML, + // XML types + XML, } from "./xml"; diff --git a/3.0/info.ts b/3.0/info.ts index c0c0669..ecb8acc 100644 --- a/3.0/info.ts +++ b/3.0/info.ts @@ -70,188 +70,188 @@ import type { Extension } from "./extensions"; * ``` */ export interface Info extends Extension { - /** - * The title of the application. This field is required. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - title} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - title} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - title} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - title} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - title} | - * - * @property `title` - Required The title of the application - * - * @example "Sample Pet Store App" - * @example "My API" - */ - title: string; + /** + * The title of the application. This field is required. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - title} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - title} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - title} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - title} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - title} | + * + * @property `title` - Required The title of the application + * + * @example "Sample Pet Store App" + * @example "My API" + */ + title: string; - /** - * A short description of the application. CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - description} | - * - * @property `description` - Optional A short description of the application - * - * @example "This is a sample server for a pet store." - * @example "A comprehensive API for managing user data" - */ - description?: string; + /** + * A short description of the application. CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - description} | + * + * @property `description` - Optional A short description of the application + * + * @example "This is a sample server for a pet store." + * @example "A comprehensive API for managing user data" + */ + description?: string; - /** - * A URL to the Terms of Service for the API. MUST be in the format of a URL. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | - * @property `termsOfService` - Optional A URL to the Terms of Service for the API - * - * @example "http://example.com/terms/" - * @example "https://example.com/terms" - */ - termsOfService?: string; + /** + * A URL to the Terms of Service for the API. MUST be in the format of a URL. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - termsOfService} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - termsOfService} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - termsOfService} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - termsOfService} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - termsOfService} | + * @property `termsOfService` - Optional A URL to the Terms of Service for the API + * + * @example "http://example.com/terms/" + * @example "https://example.com/terms" + */ + termsOfService?: string; - /** - * The contact information for the exposed API. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | - * @property `contact` - Optional The contact information for the exposed API - * - * @example { name: "API Support", email: "support@example.com" } - */ - contact?: Contact; + /** + * The contact information for the exposed API. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - contact} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - contact} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - contact} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - contact} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - contact} | + * @property `contact` - Optional The contact information for the exposed API + * + * @example { name: "API Support", email: "support@example.com" } + */ + contact?: Contact; - /** - * The license information for the exposed API. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | - * @property `license` - Optional The license information for the exposed API - * - * @example { name: "Apache 2.0", url: "http://www.apache.org/licenses/LICENSE-2.0.html" } - */ - license?: License; + /** + * The license information for the exposed API. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - license} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - license} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - license} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - license} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - license} | + * @property `license` - Optional The license information for the exposed API + * + * @example { name: "Apache 2.0", url: "http://www.apache.org/licenses/LICENSE-2.0.html" } + */ + license?: License; - /** - * The version of the OpenAPI document (which is distinct from the OpenAPI Specification version - * or the API implementation version). This field is required. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | - * @property `version` - Required The version of the OpenAPI document - * - * @example "1.0.1" - * @example "2.0.0" - */ - version: string; + /** + * The version of the OpenAPI document (which is distinct from the OpenAPI Specification version + * or the API implementation version). This field is required. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object | OpenAPI 3.0.4 Info Object - version} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object | OpenAPI 3.0.3 Info Object - version} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object | OpenAPI 3.0.2 Info Object - version} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object | OpenAPI 3.0.1 Info Object - version} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object | OpenAPI 3.0.0 Info Object - version} | + * @property `version` - Required The version of the OpenAPI document + * + * @example "1.0.1" + * @example "2.0.0" + */ + version: string; } /** @@ -317,116 +317,116 @@ export interface Info extends Extension { * ``` */ export interface Contact extends Extension { - /** - * The identifying name of the contact person/organization. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | - * @property `name` - Optional The identifying name of the contact person/organization - * - * @example "API Support" - * @example "John Doe" - */ - name?: string; + /** + * The identifying name of the contact person/organization. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - name} | + * @property `name` - Optional The identifying name of the contact person/organization + * + * @example "API Support" + * @example "John Doe" + */ + name?: string; - /** - * The URL pointing to the contact information. MUST be in the format of a URL. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | - * @property `url` - Optional A URL pointing to the contact information - * - * @example "http://www.example.com/support" - * @example "https://example.com/contact" - */ - url?: string; + /** + * The URL pointing to the contact information. MUST be in the format of a URL. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - url} | + * @property `url` - Optional A URL pointing to the contact information + * + * @example "http://www.example.com/support" + * @example "https://example.com/contact" + */ + url?: string; - /** - * The email address of the contact person/organization. MUST be in the format of an email address. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | - * @property `email` - Optional The email address of the contact person/organization - * - * @example "support@example.com" - * @example "contact@example.com" - */ - email?: string; + /** + * The email address of the contact person/organization. MUST be in the format of an email address. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object | OpenAPI 3.0.4 Contact Object - email} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object | OpenAPI 3.0.3 Contact Object - email} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object | OpenAPI 3.0.2 Contact Object - email} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object | OpenAPI 3.0.1 Contact Object - email} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object | OpenAPI 3.0.0 Contact Object - email} | + * @property `email` - Optional The email address of the contact person/organization + * + * @example "support@example.com" + * @example "contact@example.com" + */ + email?: string; } /** @@ -497,79 +497,79 @@ export interface Contact extends Extension { * ``` */ export interface License extends Extension { - /** - * The license name used for the API. This field is required. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | - * @property `name` - Required The license name used for the API - * - * @example "MIT License" - * @example "Apache 2.0" - * @example "Proprietary License" - */ - name: LicenseName; + /** + * The license name used for the API. This field is required. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - name} | + * @property `name` - Required The license name used for the API + * + * @example "MIT License" + * @example "Apache 2.0" + * @example "Proprietary License" + */ + name: LicenseName; - /** - * A URL to the license used for the API. MUST be in the format of a URL. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | - * @property `url` - Optional A URL to the license used for the API - * - * @example "https://opensource.org/license/mit/" - * @example "http://www.apache.org/licenses/LICENSE-2.0.html" - * @example "https://example.com/licenses/proprietary-1.0" - */ - url?: LicenseURL; + /** + * A URL to the license used for the API. MUST be in the format of a URL. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object | OpenAPI 3.0.4 License Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object | OpenAPI 3.0.3 License Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object | OpenAPI 3.0.2 License Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object | OpenAPI 3.0.1 License Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object | OpenAPI 3.0.0 License Object - url} | + * @property `url` - Optional A URL to the license used for the API + * + * @example "https://opensource.org/license/mit/" + * @example "http://www.apache.org/licenses/LICENSE-2.0.html" + * @example "https://example.com/licenses/proprietary-1.0" + */ + url?: LicenseURL; } diff --git a/3.0/paths.ts b/3.0/paths.ts index 5bd669b..420436e 100644 --- a/3.0/paths.ts +++ b/3.0/paths.ts @@ -154,219 +154,219 @@ export type Paths = Record & Extension; * ``` */ export type PathItem = - | ({ - /** - * Allows for an external definition of this path item. The referenced structure - * MUST be in the format of a Path Item Object. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - $ref} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - $ref} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - $ref} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - $ref} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - $ref} | - * @property `$ref` - Optional Allows for an external definition of this path item - */ - $ref?: string; + | ({ + /** + * Allows for an external definition of this path item. The referenced structure + * MUST be in the format of a Path Item Object. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - $ref} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - $ref} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - $ref} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - $ref} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - $ref} | + * @property `$ref` - Optional Allows for an external definition of this path item + */ + $ref?: string; - /** - * An optional, string summary, intended to apply to all operations in this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - summary} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - summary} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - summary} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - summary} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - summary} | - * @property `summary` - Optional An optional, string summary, intended to apply to all operations in this path - * - * @example "User management operations" - */ - summary?: string; + /** + * An optional, string summary, intended to apply to all operations in this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - summary} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - summary} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - summary} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - summary} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - summary} | + * @property `summary` - Optional An optional, string summary, intended to apply to all operations in this path + * + * @example "User management operations" + */ + summary?: string; - /** - * An optional, string description, intended to apply to all operations in this path. - * CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - description} | - * @property `description` - Optional An optional, string description, intended to apply to all operations in this path - * - * @example "Operations for managing users in the system" - */ - description?: string; + /** + * An optional, string description, intended to apply to all operations in this path. + * CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - description} | + * @property `description` - Optional An optional, string description, intended to apply to all operations in this path + * + * @example "Operations for managing users in the system" + */ + description?: string; - /** - * A definition of a GET operation on this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - get} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - get} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - get} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - get} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - get} | - * @property `get` - Optional A definition of a GET operation on this path - * - * @example { summary: "Get users", responses: { "200": { description: "Success" } } } - */ - get?: Operation; + /** + * A definition of a GET operation on this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - get} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - get} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - get} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - get} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - get} | + * @property `get` - Optional A definition of a GET operation on this path + * + * @example { summary: "Get users", responses: { "200": { description: "Success" } } } + */ + get?: Operation; - /** - * A definition of a PUT operation on this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - put} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - put} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - put} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - put} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - put} | - * @property `put` - Optional A definition of a PUT operation on this path - * - * @example { summary: "Update user", responses: { "200": { description: "Success" } } } - */ - put?: Operation; + /** + * A definition of a PUT operation on this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - put} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - put} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - put} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - put} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - put} | + * @property `put` - Optional A definition of a PUT operation on this path + * + * @example { summary: "Update user", responses: { "200": { description: "Success" } } } + */ + put?: Operation; - /** - * A definition of a POST operation on this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - post} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - post} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - post} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - post} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - post} | - * @property `post` - Optional A definition of a POST operation on this path - * - * @example { summary: "Create user", responses: { "201": { description: "Created" } } } - */ - post?: Operation; + /** + * A definition of a POST operation on this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - post} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - post} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - post} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - post} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - post} | + * @property `post` - Optional A definition of a POST operation on this path + * + * @example { summary: "Create user", responses: { "201": { description: "Created" } } } + */ + post?: Operation; - /** - * A definition of a DELETE operation on this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - delete} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - delete} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - delete} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - delete} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - delete} | - * @property `delete` - Optional A definition of a DELETE operation on this path - * - * @example { summary: "Delete user", responses: { "204": { description: "No Content" } } } - */ - delete?: Operation; + /** + * A definition of a DELETE operation on this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - delete} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - delete} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - delete} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - delete} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - delete} | + * @property `delete` - Optional A definition of a DELETE operation on this path + * + * @example { summary: "Delete user", responses: { "204": { description: "No Content" } } } + */ + delete?: Operation; - /** - * A definition of an OPTIONS operation on this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - options} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - options} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - options} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - options} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - options} | - * @property `options` - Optional A definition of an OPTIONS operation on this path - * - * @example { summary: "Get options", responses: { "200": { description: "Options" } } } - */ - options?: Operation; + /** + * A definition of an OPTIONS operation on this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - options} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - options} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - options} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - options} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - options} | + * @property `options` - Optional A definition of an OPTIONS operation on this path + * + * @example { summary: "Get options", responses: { "200": { description: "Options" } } } + */ + options?: Operation; - /** - * A definition of a HEAD operation on this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - head} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - head} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - head} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - head} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - head} | - * @property `head` - Optional A definition of a HEAD operation on this path - * - * @example { summary: "Check if resource exists", responses: { "200": { description: "Exists" } } } - */ - head?: Operation; + /** + * A definition of a HEAD operation on this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - head} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - head} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - head} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - head} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - head} | + * @property `head` - Optional A definition of a HEAD operation on this path + * + * @example { summary: "Check if resource exists", responses: { "200": { description: "Exists" } } } + */ + head?: Operation; - /** - * A definition of a PATCH operation on this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - patch} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - patch} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - patch} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - patch} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - patch} | - * @property `patch` - Optional A definition of a PATCH operation on this path - * - * @example { summary: "Partially update user", responses: { "200": { description: "Success" } } } - */ - patch?: Operation; + /** + * A definition of a PATCH operation on this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - patch} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - patch} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - patch} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - patch} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - patch} | + * @property `patch` - Optional A definition of a PATCH operation on this path + * + * @example { summary: "Partially update user", responses: { "200": { description: "Success" } } } + */ + patch?: Operation; - /** - * A definition of a TRACE operation on this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - trace} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - trace} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - trace} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - trace} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - trace} | - * @property `trace` - Optional A definition of a TRACE operation on this path - * - * @example { summary: "Trace request", responses: { "200": { description: "Success" } } } - */ - trace?: Operation; + /** + * A definition of a TRACE operation on this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - trace} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - trace} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - trace} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - trace} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - trace} | + * @property `trace` - Optional A definition of a TRACE operation on this path + * + * @example { summary: "Trace request", responses: { "200": { description: "Success" } } } + */ + trace?: Operation; - /** - * An alternative server array to service all operations in this path. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - servers} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - servers} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - servers} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - servers} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - servers} | - * @property `servers` - Optional An alternative server array to service all operations in this path - * - * @example [{ url: "https://api.example.com/v1" }] - */ - servers?: Server[]; + /** + * An alternative server array to service all operations in this path. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - servers} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - servers} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - servers} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - servers} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - servers} | + * @property `servers` - Optional An alternative server array to service all operations in this path + * + * @example [{ url: "https://api.example.com/v1" }] + */ + servers?: Server[]; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - parameters} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - parameters} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - parameters} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - parameters} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - parameters} | - * @property `parameters` - Optional A list of parameters that are applicable for all the operations described under this path - * - * @example [{ name: "limit", in: "query", schema: { type: "integer" } }] - */ - parameters?: Array; - } & Extension) - | Reference; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object | OpenAPI 3.0.4 Path Item Object - parameters} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object | OpenAPI 3.0.3 Path Item Object - parameters} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object | OpenAPI 3.0.2 Path Item Object - parameters} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object | OpenAPI 3.0.1 Path Item Object - parameters} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object | OpenAPI 3.0.0 Path Item Object - parameters} | + * @property `parameters` - Optional A list of parameters that are applicable for all the operations described under this path + * + * @example [{ name: "limit", in: "query", schema: { type: "integer" } }] + */ + parameters?: Array; + } & Extension) + | Reference; /** * ----- @@ -460,223 +460,223 @@ export type PathItem = * ``` */ export interface Operation extends Extension { - /** - * A list of tags for API documentation control. Tags can be used for logical - * grouping of operations by resources or any other qualifier. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - tags} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - tags} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - tags} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - tags} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - tags} | - * @property `tags` - Optional A list of tags for API documentation control - * - * @example ["users", "authentication"] - * @example ["pets"] - */ - tags?: string[]; + /** + * A list of tags for API documentation control. Tags can be used for logical + * grouping of operations by resources or any other qualifier. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - tags} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - tags} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - tags} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - tags} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - tags} | + * @property `tags` - Optional A list of tags for API documentation control + * + * @example ["users", "authentication"] + * @example ["pets"] + */ + tags?: string[]; - /** - * A short summary of what the operation does. For maximum readability in - * OpenAPI-UI, this field SHOULD be less than 120 characters. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - summary} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - summary} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - summary} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - summary} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - summary} | - * @property `summary` - Optional A short summary of what the operation does - * - * @example "Get user by ID" - * @example "Create a new pet" - */ - summary?: string; + /** + * A short summary of what the operation does. For maximum readability in + * OpenAPI-UI, this field SHOULD be less than 120 characters. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - summary} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - summary} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - summary} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - summary} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - summary} | + * @property `summary` - Optional A short summary of what the operation does + * + * @example "Get user by ID" + * @example "Create a new pet" + */ + summary?: string; - /** - * A verbose explanation of the operation behavior. CommonMark syntax MAY be used - * for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - description} | - * @property `description` - Optional A verbose explanation of the operation behavior - * - * @example "Retrieves a specific user by their unique identifier. Returns user details including name, email, and profile information." - */ - description?: string; + /** + * A verbose explanation of the operation behavior. CommonMark syntax MAY be used + * for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - description} | + * @property `description` - Optional A verbose explanation of the operation behavior + * + * @example "Retrieves a specific user by their unique identifier. Returns user details including name, email, and profile information." + */ + description?: string; - /** - * Additional external documentation for this operation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - externalDocs} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - externalDocs} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - externalDocs} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - externalDocs} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - externalDocs} | - * @property `externalDocs` - Optional Additional external documentation for this operation - * - * @example { description: "Find out more about this operation", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for this operation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - externalDocs} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - externalDocs} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - externalDocs} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - externalDocs} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - externalDocs} | + * @property `externalDocs` - Optional Additional external documentation for this operation + * + * @example { description: "Find out more about this operation", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - operationId} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - operationId} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - operationId} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - operationId} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - operationId} | - * @property `operationId` - Optional Unique string used to identify the operation - * - * @example "getUserById" - * @example "createPet" - */ - operationId?: string; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - operationId} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - operationId} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - operationId} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - operationId} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - operationId} | + * @property `operationId` - Optional Unique string used to identify the operation + * + * @example "getUserById" + * @example "createPet" + */ + operationId?: string; - /** - * A list of parameters that are applicable for this operation. If a parameter - * is already defined at the Path Item, the new definition will override it - * but can never remove it. The list MUST NOT include duplicated parameters. - * A unique parameter is defined by a combination of a name and location. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - parameters} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - parameters} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - parameters} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - parameters} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - parameters} | - * @property `parameters` - Optional A list of parameters that are applicable for this operation - * - * @example [{ name: "id", in: "path", required: true, schema: { type: "string" } }] - */ - parameters?: Array; + /** + * A list of parameters that are applicable for this operation. If a parameter + * is already defined at the Path Item, the new definition will override it + * but can never remove it. The list MUST NOT include duplicated parameters. + * A unique parameter is defined by a combination of a name and location. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - parameters} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - parameters} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - parameters} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - parameters} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - parameters} | + * @property `parameters` - Optional A list of parameters that are applicable for this operation + * + * @example [{ name: "id", in: "path", required: true, schema: { type: "string" } }] + */ + parameters?: Array; - /** - * The request body applicable for this operation. The requestBody is only - * supported in HTTP methods where the HTTP 1.1 specification has explicitly - * defined semantics for request bodies. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - requestBody} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - requestBody} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - requestBody} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - requestBody} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - requestBody} | - * @property `requestBody` - Optional The request body applicable for this operation - * - * @example { description: "User data", content: { "application/json": { schema: { $ref: "#/components/schemas/User" } } } } - */ - requestBody?: RequestBody | Reference; + /** + * The request body applicable for this operation. The requestBody is only + * supported in HTTP methods where the HTTP 1.1 specification has explicitly + * defined semantics for request bodies. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - requestBody} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - requestBody} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - requestBody} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - requestBody} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - requestBody} | + * @property `requestBody` - Optional The request body applicable for this operation + * + * @example { description: "User data", content: { "application/json": { schema: { $ref: "#/components/schemas/User" } } } } + */ + requestBody?: RequestBody | Reference; - /** - * The list of possible responses as they are returned from executing this operation. - * This field MUST be present and MUST contain at least one response. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - responses} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - responses} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - responses} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - responses} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - responses} | - * @property `responses` - Required The list of possible responses as they are returned from executing this operation - * - * @example { "200": { description: "Success", content: { "application/json": { schema: { type: "object" } } } } } - */ - responses: ResponsesMap; + /** + * The list of possible responses as they are returned from executing this operation. + * This field MUST be present and MUST contain at least one response. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - responses} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - responses} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - responses} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - responses} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - responses} | + * @property `responses` - Required The list of possible responses as they are returned from executing this operation + * + * @example { "200": { description: "Success", content: { "application/json": { schema: { type: "object" } } } } } + */ + responses: ResponsesMap; - /** - * A map of possible out-of band callbacks related to the parent operation. - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - callbacks} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - callbacks} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - callbacks} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - callbacks} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - callbacks} | - * @property `callbacks` - Optional A map of possible out-of band callbacks related to the parent operation - * - * @example { "myCallback": { "{$request.body#/callbackUrl}": { post: { ... } } } } - */ - callbacks?: Record; + /** + * A map of possible out-of band callbacks related to the parent operation. + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - callbacks} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - callbacks} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - callbacks} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - callbacks} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - callbacks} | + * @property `callbacks` - Optional A map of possible out-of band callbacks related to the parent operation + * + * @example { "myCallback": { "{$request.body#/callbackUrl}": { post: { ... } } } } + */ + callbacks?: Record; - /** - * Declares this operation to be deprecated. Consumers SHOULD refrain from usage - * of the declared operation. Default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - deprecated} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - deprecated} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - deprecated} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - deprecated} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - deprecated} | - * @property `deprecated` - Optional Declares this operation to be deprecated - * - * @default false - * @example true - */ - deprecated?: boolean; + /** + * Declares this operation to be deprecated. Consumers SHOULD refrain from usage + * of the declared operation. Default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - deprecated} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - deprecated} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - deprecated} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - deprecated} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - deprecated} | + * @property `deprecated` - Optional Declares this operation to be deprecated + * + * @default false + * @example true + */ + deprecated?: boolean; - /** - * A declaration of which security mechanisms can be used for this operation. - * The list of values includes alternative security requirement objects that can be used. - * Only one of the security requirement objects need to be satisfied to authorize a request. - * This definition overrides any declared top-level security. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - security} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - security} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - security} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - security} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - security} | - * @property `security` - Optional A declaration of which security mechanisms can be used for this operation - * - * @example [{ "api_key": [] }] - * @example [{ "oauth2": ["read", "write"] }] - */ - security?: SecurityRequirement[]; + /** + * A declaration of which security mechanisms can be used for this operation. + * The list of values includes alternative security requirement objects that can be used. + * Only one of the security requirement objects need to be satisfied to authorize a request. + * This definition overrides any declared top-level security. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - security} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - security} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - security} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - security} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - security} | + * @property `security` - Optional A declaration of which security mechanisms can be used for this operation + * + * @example [{ "api_key": [] }] + * @example [{ "oauth2": ["read", "write"] }] + */ + security?: SecurityRequirement[]; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - servers} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - servers} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - servers} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - servers} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - servers} | - * @property `servers` - Optional An alternative server array to service this operation - * - * @example [{ url: "https://api.example.com/v1" }] - */ - servers?: Server[]; + /** + * An alternative server array to service this operation. If an alternative + * server object is specified at the Path Item Object or Root level, it will + * be overridden by this value. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object | OpenAPI 3.0.4 Operation Object - servers} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object | OpenAPI 3.0.3 Operation Object - servers} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object | OpenAPI 3.0.2 Operation Object - servers} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object | OpenAPI 3.0.1 Operation Object - servers} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object | OpenAPI 3.0.0 Operation Object - servers} | + * @property `servers` - Optional An alternative server array to service this operation + * + * @example [{ url: "https://api.example.com/v1" }] + */ + servers?: Server[]; } /** @@ -739,261 +739,261 @@ export interface Operation extends Extension { * ``` */ export interface Parameter extends Extension { - /** - * The name of the parameter. Parameter names are case sensitive. - * - If in is "path", the name field MUST correspond to the associated path segment - * - 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 - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - name} | - * @property `name` - Required The name of the parameter - * - * @example "id" - * @example "limit" - * @example "user" - */ - name: string; + /** + * The name of the parameter. Parameter names are case sensitive. + * - If in is "path", the name field MUST correspond to the associated path segment + * - 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 + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - name} | + * @property `name` - Required The name of the parameter + * + * @example "id" + * @example "limit" + * @example "user" + */ + name: string; - /** - * The location of the parameter. Possible values are "query", "header", "path" or "cookie". - * - * - **query**: Parameters that are appended to the URL - * - **header**: Custom headers that are expected as part of the request - * - **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL - * - **cookie**: Used to pass a specific cookie value to the API - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - in} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - in} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - in} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - in} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - in} | - * @property `in` - Required The location of the parameter - * - * @example "query" - * @example "path" - * @example "header" - * @example "cookie" - */ - in: "query" | "header" | "path" | "cookie"; + /** + * The location of the parameter. Possible values are "query", "header", "path" or "cookie". + * + * - **query**: Parameters that are appended to the URL + * - **header**: Custom headers that are expected as part of the request + * - **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL + * - **cookie**: Used to pass a specific cookie value to the API + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - in} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - in} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - in} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - in} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - in} | + * @property `in` - Required The location of the parameter + * + * @example "query" + * @example "path" + * @example "header" + * @example "cookie" + */ + in: "query" | "header" | "path" | "cookie"; - /** - * A brief description of the parameter. This could contain examples of use. - * CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - description} | - * @property `description` - Optional A brief description of the parameter - * - * @example "User ID to retrieve" - * @example "Number of items to return" - */ - description?: string; + /** + * A brief description of the parameter. This could contain examples of use. + * CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - description} | + * @property `description` - Optional A brief description of the parameter + * + * @example "User ID to retrieve" + * @example "Number of items to return" + */ + description?: string; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - required} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - required} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - required} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - required} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - required} | - * @property `required` - Optional Determines whether this parameter is mandatory - * - * @example true - * @example false - */ - required?: boolean; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - required} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - required} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - required} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - required} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - required} | + * @property `required` - Optional Determines whether this parameter is mandatory + * + * @example true + * @example false + */ + required?: boolean; - /** - * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - deprecated} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - deprecated} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - deprecated} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - deprecated} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - deprecated} | - * @property `deprecated` - Optional Specifies that a parameter is deprecated and SHOULD be transitioned out of usage - * - * @example true - * @example false - */ - deprecated?: boolean; + /** + * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - deprecated} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - deprecated} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - deprecated} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - deprecated} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - deprecated} | + * @property `deprecated` - Optional Specifies that a parameter is deprecated and SHOULD be transitioned out of usage + * + * @example true + * @example false + */ + deprecated?: boolean; - /** - * Sets the ability to pass empty-valued parameters. This is valid only for query - * parameters and allows sending a parameter with an empty value. Default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - allowEmptyValue} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - allowEmptyValue} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - allowEmptyValue} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - allowEmptyValue} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - allowEmptyValue} | - * @property `allowEmptyValue` - Optional Sets the ability to pass empty-valued parameters - * - * @example true - * @example false - */ - allowEmptyValue?: boolean; + /** + * Sets the ability to pass empty-valued parameters. This is valid only for query + * parameters and allows sending a parameter with an empty value. Default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - allowEmptyValue} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - allowEmptyValue} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - allowEmptyValue} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - allowEmptyValue} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - allowEmptyValue} | + * @property `allowEmptyValue` - Optional Sets the ability to pass empty-valued parameters + * + * @example true + * @example false + */ + allowEmptyValue?: boolean; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - style} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - style} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - style} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - style} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - style} | - * @property `style` - Optional Describes how the parameter value will be serialized - * - * @example "form" - * @example "simple" - * @example "matrix" - * @example "label" - * @example "spaceDelimited" - * @example "pipeDelimited" - * @example "deepObject" - */ - style?: - | "matrix" - | "label" - | "form" - | "simple" - | "spaceDelimited" - | "pipeDelimited" - | "deepObject"; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - style} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - style} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - style} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - style} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - style} | + * @property `style` - Optional Describes how the parameter value will be serialized + * + * @example "form" + * @example "simple" + * @example "matrix" + * @example "label" + * @example "spaceDelimited" + * @example "pipeDelimited" + * @example "deepObject" + */ + style?: + | "matrix" + | "label" + | "form" + | "simple" + | "spaceDelimited" + | "pipeDelimited" + | "deepObject"; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - explode} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - explode} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - explode} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - explode} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - explode} | - * @property `explode` - Optional When this is true, parameter values of type array or object generate separate parameters - * - * @example true - * @example false - */ - explode?: boolean; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - explode} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - explode} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - explode} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - explode} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - explode} | + * @property `explode` - Optional When this is true, parameter values of type array or object generate separate parameters + * + * @example true + * @example false + */ + explode?: boolean; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - allowReserved} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - allowReserved} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - allowReserved} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - allowReserved} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - allowReserved} | - * @property `allowReserved` - Optional Determines whether the parameter value SHOULD allow reserved characters - * - * @example true - * @example false - */ - allowReserved?: boolean; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - allowReserved} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - allowReserved} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - allowReserved} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - allowReserved} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - allowReserved} | + * @property `allowReserved` - Optional Determines whether the parameter value SHOULD allow reserved characters + * + * @example true + * @example false + */ + allowReserved?: boolean; - /** - * The schema defining the type used for the parameter. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - schema} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - schema} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - schema} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - schema} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - schema} | - * @property `schema` - Optional The schema defining the type used for the parameter - * - * @example { type: "string" } - * @example { type: "integer", minimum: 1, maximum: 100 } - */ - schema?: Schema; + /** + * The schema defining the type used for the parameter. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - schema} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - schema} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - schema} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - schema} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - schema} | + * @property `schema` - Optional The schema defining the type used for the parameter + * + * @example { type: "string" } + * @example { type: "integer", minimum: 1, maximum: 100 } + */ + schema?: Schema; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - example} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - example} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - example} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - example} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - example} | - * @property `example` - Optional Example of the media type - * - * @example "example-value" - * @example 42 - */ - example?: unknown; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - example} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - example} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - example} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - example} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - example} | + * @property `example` - Optional Example of the media type + * + * @example "example-value" + * @example 42 + */ + example?: unknown; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - examples} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - examples} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - examples} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - examples} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - examples} | - * @property `examples` - Optional Examples of the media type - * - * @example { "user1": { summary: "A user example", value: "user123" } } - */ - examples?: Record; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - examples} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - examples} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - examples} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - examples} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - examples} | + * @property `examples` - Optional Examples of the media type + * + * @example { "user1": { summary: "A user example", value: "user123" } } + */ + examples?: Record; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - content} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - content} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - content} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - content} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - content} | - * @property `content` - Optional A map containing the representations for the parameter - * - * @example { "application/json": { schema: { type: "object" } } } - */ - content?: Record; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object | OpenAPI 3.0.4 Parameter Object - content} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object | OpenAPI 3.0.3 Parameter Object - content} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object | OpenAPI 3.0.2 Parameter Object - content} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object | OpenAPI 3.0.1 Parameter Object - content} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object | OpenAPI 3.0.0 Parameter Object - content} | + * @property `content` - Optional A map containing the representations for the parameter + * + * @example { "application/json": { schema: { type: "object" } } } + */ + content?: Record; } /** @@ -1036,58 +1036,58 @@ export interface Parameter extends Extension { * ``` */ export interface RequestBody extends Extension { - /** - * A brief description of the request body. This could contain examples of use. - * CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object | OpenAPI 3.0.4 Request Body Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object | OpenAPI 3.0.3 Request Body Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object | OpenAPI 3.0.2 Request Body Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object | OpenAPI 3.0.1 Request Body Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object | OpenAPI 3.0.0 Request Body Object - description} | - * @property `description` - Optional A brief description of the request body - * - * @example "User data to create" - * @example "Pet information" - */ - description?: string; + /** + * A brief description of the request body. This could contain examples of use. + * CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object | OpenAPI 3.0.4 Request Body Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object | OpenAPI 3.0.3 Request Body Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object | OpenAPI 3.0.2 Request Body Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object | OpenAPI 3.0.1 Request Body Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object | OpenAPI 3.0.0 Request Body Object - description} | + * @property `description` - Optional A brief description of the request body + * + * @example "User data to create" + * @example "Pet information" + */ + description?: string; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object | OpenAPI 3.0.4 Request Body Object - content} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object | OpenAPI 3.0.3 Request Body Object - content} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object | OpenAPI 3.0.2 Request Body Object - content} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object | OpenAPI 3.0.1 Request Body Object - content} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object | OpenAPI 3.0.0 Request Body Object - content} | - * @property `content` - Required The content of the request body - * - * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } - */ - content: Record; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object | OpenAPI 3.0.4 Request Body Object - content} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object | OpenAPI 3.0.3 Request Body Object - content} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object | OpenAPI 3.0.2 Request Body Object - content} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object | OpenAPI 3.0.1 Request Body Object - content} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object | OpenAPI 3.0.0 Request Body Object - content} | + * @property `content` - Required The content of the request body + * + * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } + */ + content: Record; - /** - * Determines if the request body is required in the request. Defaults to false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object | OpenAPI 3.0.4 Request Body Object - required} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object | OpenAPI 3.0.3 Request Body Object - required} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object | OpenAPI 3.0.2 Request Body Object - required} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object | OpenAPI 3.0.1 Request Body Object - required} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object | OpenAPI 3.0.0 Request Body Object - required} | - * @property `required` - Optional Determines if the request body is required in the request - * - * @default false - * @example true - */ - required?: boolean; + /** + * Determines if the request body is required in the request. Defaults to false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object | OpenAPI 3.0.4 Request Body Object - required} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object | OpenAPI 3.0.3 Request Body Object - required} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object | OpenAPI 3.0.2 Request Body Object - required} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object | OpenAPI 3.0.1 Request Body Object - required} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object | OpenAPI 3.0.0 Request Body Object - required} | + * @property `required` - Optional Determines if the request body is required in the request + * + * @default false + * @example true + */ + required?: boolean; } /** @@ -1126,76 +1126,76 @@ export interface RequestBody extends Extension { * ``` */ export interface MediaType extends Extension { - /** - * The schema defining the type used for the request body. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object | OpenAPI 3.0.4 Media Type Object - schema} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object | OpenAPI 3.0.3 Media Type Object - schema} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object | OpenAPI 3.0.2 Media Type Object - schema} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object | OpenAPI 3.0.1 Media Type Object - schema} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object | OpenAPI 3.0.0 Media Type Object - schema} | - * @property `schema` - Optional The schema defining the type used for the request body - * - * @example { $ref: "#/components/schemas/User" } - * @example { type: "object", properties: { name: { type: "string" } } } - */ - schema?: Schema | Reference; + /** + * The schema defining the type used for the request body. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object | OpenAPI 3.0.4 Media Type Object - schema} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object | OpenAPI 3.0.3 Media Type Object - schema} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object | OpenAPI 3.0.2 Media Type Object - schema} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object | OpenAPI 3.0.1 Media Type Object - schema} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object | OpenAPI 3.0.0 Media Type Object - schema} | + * @property `schema` - Optional The schema defining the type used for the request body + * + * @example { $ref: "#/components/schemas/User" } + * @example { type: "object", properties: { name: { type: "string" } } } + */ + schema?: Schema | Reference; - /** - * Example of the media type. The example object SHOULD be in the correct format - * as specified by the media type. The example object is mutually exclusive of - * the examples object. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object | OpenAPI 3.0.4 Media Type Object - example} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object | OpenAPI 3.0.3 Media Type Object - example} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object | OpenAPI 3.0.2 Media Type Object - example} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object | OpenAPI 3.0.1 Media Type Object - example} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object | OpenAPI 3.0.0 Media Type Object - example} | - * @property `example` - Optional Example of the media type - * - * @example { name: "John Doe", email: "john@example.com" } - */ - example?: unknown; + /** + * Example of the media type. The example object SHOULD be in the correct format + * as specified by the media type. The example object is mutually exclusive of + * the examples object. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object | OpenAPI 3.0.4 Media Type Object - example} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object | OpenAPI 3.0.3 Media Type Object - example} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object | OpenAPI 3.0.2 Media Type Object - example} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object | OpenAPI 3.0.1 Media Type Object - example} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object | OpenAPI 3.0.0 Media Type Object - example} | + * @property `example` - Optional Example of the media type + * + * @example { name: "John Doe", email: "john@example.com" } + */ + example?: unknown; - /** - * Examples of the media type. Each example object SHOULD match the media type - * and specified schema if present. The examples object is mutually exclusive of - * the example object. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object | OpenAPI 3.0.4 Media Type Object - examples} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object | OpenAPI 3.0.3 Media Type Object - examples} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object | OpenAPI 3.0.2 Media Type Object - examples} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object | OpenAPI 3.0.1 Media Type Object - examples} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object | OpenAPI 3.0.0 Media Type Object - examples} | - * @property `examples` - Optional Examples of the media type - * - * @example { "user1": { summary: "A user example", value: { name: "John" } } } - */ - examples?: Record; + /** + * Examples of the media type. Each example object SHOULD match the media type + * and specified schema if present. The examples object is mutually exclusive of + * the example object. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object | OpenAPI 3.0.4 Media Type Object - examples} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object | OpenAPI 3.0.3 Media Type Object - examples} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object | OpenAPI 3.0.2 Media Type Object - examples} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object | OpenAPI 3.0.1 Media Type Object - examples} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object | OpenAPI 3.0.0 Media Type Object - examples} | + * @property `examples` - Optional Examples of the media type + * + * @example { "user1": { summary: "A user example", value: { name: "John" } } } + */ + examples?: Record; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object | OpenAPI 3.0.4 Media Type Object - encoding} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object | OpenAPI 3.0.3 Media Type Object - encoding} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object | OpenAPI 3.0.2 Media Type Object - encoding} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object | OpenAPI 3.0.1 Media Type Object - encoding} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object | OpenAPI 3.0.0 Media Type Object - encoding} | - * @property `encoding` - Optional A map between a property name and its encoding information - * - * @example { "profileImage": { contentType: "image/png" } } - */ - encoding?: Record; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object | OpenAPI 3.0.4 Media Type Object - encoding} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object | OpenAPI 3.0.3 Media Type Object - encoding} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object | OpenAPI 3.0.2 Media Type Object - encoding} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object | OpenAPI 3.0.1 Media Type Object - encoding} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object | OpenAPI 3.0.0 Media Type Object - encoding} | + * @property `encoding` - Optional A map between a property name and its encoding information + * + * @example { "profileImage": { contentType: "image/png" } } + */ + encoding?: Record; } /** @@ -1235,97 +1235,97 @@ export interface MediaType extends Extension { * ``` */ export interface Encoding extends Extension { - /** - * The Content-Type for encoding a specific property. Default value depends on the property type. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - contentType} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - contentType} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - contentType} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - contentType} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - contentType} | - * @property `contentType` - Optional The Content-Type for encoding a specific property - * - * @example "image/png" - * @example "application/json" - * @example "text/plain" - */ - contentType?: string; + /** + * The Content-Type for encoding a specific property. Default value depends on the property type. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - contentType} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - contentType} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - contentType} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - contentType} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - contentType} | + * @property `contentType` - Optional The Content-Type for encoding a specific property + * + * @example "image/png" + * @example "application/json" + * @example "text/plain" + */ + contentType?: string; - /** - * A map allowing additional information to be provided as headers, for example - * Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - headers} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - headers} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - headers} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - headers} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - headers} | - * @property `headers` - Optional A map allowing additional information to be provided as headers - * - * @example { "Content-Disposition": { schema: { type: "string" } } } - */ - headers?: Record; + /** + * A map allowing additional information to be provided as headers, for example + * Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - headers} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - headers} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - headers} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - headers} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - headers} | + * @property `headers` - Optional A map allowing additional information to be provided as headers + * + * @example { "Content-Disposition": { schema: { type: "string" } } } + */ + headers?: Record; - /** - * Describes how a specific property value will be serialized depending on its type. - * See Parameter Object for details on the style property. The behavior follows the - * same values as query parameters, including default values. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - style} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - style} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - style} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - style} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - style} | - * @property `style` - Optional Describes how a specific property value will be serialized - * - * @example "form" - * @example "simple" - */ - style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject"; + /** + * Describes how a specific property value will be serialized depending on its type. + * See Parameter Object for details on the style property. The behavior follows the + * same values as query parameters, including default values. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - style} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - style} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - style} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - style} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - style} | + * @property `style` - Optional Describes how a specific property value will be serialized + * + * @example "form" + * @example "simple" + */ + style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject"; - /** - * When this is true, property 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 properties - * this property has no effect. When style is form, the default value is true. - * For all other styles, the default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - explode} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - explode} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - explode} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - explode} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - explode} | - * @property `explode` - Optional When this is true, property values of type array or object generate separate parameters - * - * @example true - * @example false - */ - explode?: boolean; + /** + * When this is true, property 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 properties + * this property has no effect. When style is form, the default value is true. + * For all other styles, the default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - explode} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - explode} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - explode} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - explode} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - explode} | + * @property `explode` - Optional When this is true, property values of type array or object generate separate parameters + * + * @example true + * @example false + */ + explode?: boolean; - /** - * Determines whether the parameter value SHOULD allow reserved characters, as defined by - * RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - allowReserved} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - allowReserved} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - allowReserved} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - allowReserved} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - allowReserved} | - * @property `allowReserved` - Optional Determines whether the parameter value SHOULD allow reserved characters - * - * @example true - * @example false - */ - allowReserved?: boolean; + /** + * Determines whether the parameter value SHOULD allow reserved characters, as defined by + * RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object | OpenAPI 3.0.4 Encoding Object - allowReserved} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object | OpenAPI 3.0.3 Encoding Object - allowReserved} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object | OpenAPI 3.0.2 Encoding Object - allowReserved} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object | OpenAPI 3.0.1 Encoding Object - allowReserved} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object | OpenAPI 3.0.0 Encoding Object - allowReserved} | + * @property `allowReserved` - Optional Determines whether the parameter value SHOULD allow reserved characters + * + * @example true + * @example false + */ + allowReserved?: boolean; } /** @@ -1374,76 +1374,76 @@ export interface Encoding extends Extension { * ``` */ export interface Response extends Extension { - /** - * A short description of the response. CommonMark syntax MAY be used for rich text representation. - * This field is required. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object | OpenAPI 3.0.4 Response Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object | OpenAPI 3.0.3 Response Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object | OpenAPI 3.0.2 Response Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object | OpenAPI 3.0.1 Response Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object | OpenAPI 3.0.0 Response Object - description} | - * @property `description` - Required A short description of the response - * - * @example "User successfully retrieved" - * @example "Bad request - invalid input parameters" - * @example "Internal server error" - */ - description: string; + /** + * A short description of the response. CommonMark syntax MAY be used for rich text representation. + * This field is required. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object | OpenAPI 3.0.4 Response Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object | OpenAPI 3.0.3 Response Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object | OpenAPI 3.0.2 Response Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object | OpenAPI 3.0.1 Response Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object | OpenAPI 3.0.0 Response Object - description} | + * @property `description` - Required A short description of the response + * + * @example "User successfully retrieved" + * @example "Bad request - invalid input parameters" + * @example "Internal server error" + */ + description: string; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object | OpenAPI 3.0.4 Response Object - headers} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object | OpenAPI 3.0.3 Response Object - headers} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object | OpenAPI 3.0.2 Response Object - headers} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object | OpenAPI 3.0.1 Response Object - headers} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object | OpenAPI 3.0.0 Response Object - headers} | - * @property `headers` - Optional Maps a header name to its definition - * - * @example { "X-RateLimit-Limit": { schema: { type: "integer" } } } - */ - headers?: Record; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object | OpenAPI 3.0.4 Response Object - headers} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object | OpenAPI 3.0.3 Response Object - headers} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object | OpenAPI 3.0.2 Response Object - headers} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object | OpenAPI 3.0.1 Response Object - headers} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object | OpenAPI 3.0.0 Response Object - headers} | + * @property `headers` - Optional Maps a header name to its definition + * + * @example { "X-RateLimit-Limit": { schema: { type: "integer" } } } + */ + headers?: Record; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object | OpenAPI 3.0.4 Response Object - content} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object | OpenAPI 3.0.3 Response Object - content} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object | OpenAPI 3.0.2 Response Object - content} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object | OpenAPI 3.0.1 Response Object - content} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object | OpenAPI 3.0.0 Response Object - content} | - * @property `content` - Optional A map containing descriptions of potential response payloads - * - * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } - */ - content?: Record; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object | OpenAPI 3.0.4 Response Object - content} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object | OpenAPI 3.0.3 Response Object - content} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object | OpenAPI 3.0.2 Response Object - content} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object | OpenAPI 3.0.1 Response Object - content} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object | OpenAPI 3.0.0 Response Object - content} | + * @property `content` - Optional A map containing descriptions of potential response payloads + * + * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } + */ + content?: Record; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object | OpenAPI 3.0.4 Response Object - links} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object | OpenAPI 3.0.3 Response Object - links} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object | OpenAPI 3.0.2 Response Object - links} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object | OpenAPI 3.0.1 Response Object - links} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object | OpenAPI 3.0.0 Response Object - links} | - * @property `links` - Optional A map of operations links that can be followed from the response - * - * @example { "GetUserByUserId": { operationId: "getUserById", parameters: { userId: "$response.body#/id" } } } - */ - links?: Record; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object | OpenAPI 3.0.4 Response Object - links} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object | OpenAPI 3.0.3 Response Object - links} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object | OpenAPI 3.0.2 Response Object - links} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object | OpenAPI 3.0.1 Response Object - links} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object | OpenAPI 3.0.0 Response Object - links} | + * @property `links` - Optional A map of operations links that can be followed from the response + * + * @example { "GetUserByUserId": { operationId: "getUserById", parameters: { userId: "$response.body#/id" } } } + */ + links?: Record; } /** @@ -1473,179 +1473,179 @@ export interface Response extends Extension { * ``` */ export interface Header extends Extension { - /** - * A brief description of the header. CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - description} | - * @property `description` - Optional A brief description of the header - * - * @example "Rate limit for the current period" - * @example "Content type of the response" - */ - description?: string; + /** + * A brief description of the header. CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - description} | + * @property `description` - Optional A brief description of the header + * + * @example "Rate limit for the current period" + * @example "Content type of the response" + */ + description?: string; - /** - * Determines whether this header is mandatory. The property MAY be included and its default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - required} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - required} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - required} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - required} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - required} | - * @property `required` - Optional Determines whether this header is mandatory - * - * @example true - * @example false - */ - required?: boolean; + /** + * Determines whether this header is mandatory. The property MAY be included and its default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - required} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - required} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - required} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - required} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - required} | + * @property `required` - Optional Determines whether this header is mandatory + * + * @example true + * @example false + */ + required?: boolean; - /** - * Specifies that a header is deprecated and SHOULD be transitioned out of usage. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - deprecated} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - deprecated} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - deprecated} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - deprecated} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - deprecated} | - * @property `deprecated` - Optional Specifies that a header is deprecated and SHOULD be transitioned out of usage - * - * @example true - * @example false - */ - deprecated?: boolean; + /** + * Specifies that a header is deprecated and SHOULD be transitioned out of usage. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - deprecated} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - deprecated} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - deprecated} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - deprecated} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - deprecated} | + * @property `deprecated` - Optional Specifies that a header is deprecated and SHOULD be transitioned out of usage + * + * @example true + * @example false + */ + deprecated?: boolean; - /** - * Sets the ability to pass empty-valued headers. This is valid only for headers - * and allows sending a header with an empty value. Default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - allowEmptyValue} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - allowEmptyValue} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - allowEmptyValue} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - allowEmptyValue} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - allowEmptyValue} | - * @property `allowEmptyValue` - Optional Sets the ability to pass empty-valued headers - * - * @example true - * @example false - */ - allowEmptyValue?: boolean; + /** + * Sets the ability to pass empty-valued headers. This is valid only for headers + * and allows sending a header with an empty value. Default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - allowEmptyValue} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - allowEmptyValue} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - allowEmptyValue} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - allowEmptyValue} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - allowEmptyValue} | + * @property `allowEmptyValue` - Optional Sets the ability to pass empty-valued headers + * + * @example true + * @example false + */ + allowEmptyValue?: boolean; - /** - * Describes how the header value will be serialized. The default value is simple. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - style} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - style} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - style} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - style} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - style} | - * @property `style` - Optional Describes how the header value will be serialized - * - * @example "simple" - */ - style?: "simple"; + /** + * Describes how the header value will be serialized. The default value is simple. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - style} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - style} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - style} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - style} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - style} | + * @property `style` - Optional Describes how the header value will be serialized + * + * @example "simple" + */ + style?: "simple"; - /** - * When this is true, header values of type array or object generate separate headers - * for each value of the array or key-value pair of the map. For other types of headers - * this property has no effect. The default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - explode} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - explode} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - explode} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - explode} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - explode} | - * @property `explode` - Optional When this is true, header values of type array or object generate separate headers - * - * @example true - * @example false - */ - explode?: boolean; + /** + * When this is true, header values of type array or object generate separate headers + * for each value of the array or key-value pair of the map. For other types of headers + * this property has no effect. The default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - explode} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - explode} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - explode} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - explode} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - explode} | + * @property `explode` - Optional When this is true, header values of type array or object generate separate headers + * + * @example true + * @example false + */ + explode?: boolean; - /** - * The schema defining the type used for the header. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - schema} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - schema} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - schema} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - schema} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - schema} | - * @property `schema` - Optional The schema defining the type used for the header - * - * @example { type: "integer" } - * @example { type: "string" } - */ - schema?: Schema | Reference; + /** + * The schema defining the type used for the header. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - schema} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - schema} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - schema} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - schema} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - schema} | + * @property `schema` - Optional The schema defining the type used for the header + * + * @example { type: "integer" } + * @example { type: "string" } + */ + schema?: Schema | Reference; - /** - * 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - example} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - example} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - example} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - example} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - example} | - * @property `example` - Optional Example of the media type - * - * @example "example-value" - * @example 42 - */ - example?: unknown; + /** + * 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - example} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - example} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - example} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - example} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - example} | + * @property `example` - Optional Example of the media type + * + * @example "example-value" + * @example 42 + */ + example?: unknown; - /** - * Examples of the media type. Each example SHOULD contain a value in the correct format - * as specified in the header encoding. The examples object is mutually exclusive of - * the example object. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - examples} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - examples} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - examples} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - examples} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - examples} | - * @property `examples` - Optional Examples of the media type - * - * @example { "header1": { summary: "A header example", value: "value123" } } - */ - examples?: Record; + /** + * Examples of the media type. Each example SHOULD contain a value in the correct format + * as specified in the header encoding. The examples object is mutually exclusive of + * the example object. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - examples} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - examples} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - examples} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - examples} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - examples} | + * @property `examples` - Optional Examples of the media type + * + * @example { "header1": { summary: "A header example", value: "value123" } } + */ + examples?: Record; - /** - * A map containing the representations for the header. The key is the media type - * and the value describes it. The map MUST only contain one entry. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - content} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - content} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - content} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - content} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - content} | - * @property `content` - Optional A map containing the representations for the header - * - * @example { "application/json": { schema: { type: "object" } } } - */ - content?: Record; + /** + * A map containing the representations for the header. The key is the media type + * and the value describes it. The map MUST only contain one entry. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object | OpenAPI 3.0.4 Header Object - content} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object | OpenAPI 3.0.3 Header Object - content} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object | OpenAPI 3.0.2 Header Object - content} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object | OpenAPI 3.0.1 Header Object - content} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object | OpenAPI 3.0.0 Header Object - content} | + * @property `content` - Optional A map containing the representations for the header + * + * @example { "application/json": { schema: { type: "object" } } } + */ + content?: Record; } /** @@ -1800,110 +1800,110 @@ export type Callback = Record; * ``` */ export interface Link extends Extension { - /** - * A relative or absolute reference to an OAS operation. This field is mutually - * exclusive of the operationId field, and MUST point to an Operation Object. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - operationRef} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - operationRef} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - operationRef} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - operationRef} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - operationRef} | - * @property `operationRef` - Optional A relative or absolute reference to an OAS operation - * - * @example "#/paths/~12.0~1repositories~1{username}/get" - * @example "https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get" - */ - operationRef?: string; + /** + * A relative or absolute reference to an OAS operation. This field is mutually + * exclusive of the operationId field, and MUST point to an Operation Object. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - operationRef} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - operationRef} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - operationRef} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - operationRef} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - operationRef} | + * @property `operationRef` - Optional A relative or absolute reference to an OAS operation + * + * @example "#/paths/~12.0~1repositories~1{username}/get" + * @example "https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get" + */ + operationRef?: string; - /** - * The name of an existing, resolvable OAS operation, as defined with a unique operationId. - * This field is mutually exclusive of the operationRef field. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - operationId} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - operationId} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - operationId} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - operationId} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - operationId} | - * @property `operationId` - Optional The name of an existing, resolvable OAS operation - * - * @example "getUserById" - * @example "createPet" - */ - operationId?: string; + /** + * The name of an existing, resolvable OAS operation, as defined with a unique operationId. + * This field is mutually exclusive of the operationRef field. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - operationId} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - operationId} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - operationId} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - operationId} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - operationId} | + * @property `operationId` - Optional The name of an existing, resolvable OAS operation + * + * @example "getUserById" + * @example "createPet" + */ + operationId?: string; - /** - * A map representing parameters to pass to an operation as specified with operationId - * or identified via operationRef. The key is the parameter name to be used, whereas - * the value can be a constant or an expression to be evaluated and passed to the linked operation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - parameters} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - parameters} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - parameters} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - parameters} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - parameters} | - * @property `parameters` - Optional A map representing parameters to pass to an operation - * - * @example { userId: "$response.body#/id" } - * @example { limit: 10 } - */ - parameters?: Record; + /** + * A map representing parameters to pass to an operation as specified with operationId + * or identified via operationRef. The key is the parameter name to be used, whereas + * the value can be a constant or an expression to be evaluated and passed to the linked operation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - parameters} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - parameters} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - parameters} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - parameters} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - parameters} | + * @property `parameters` - Optional A map representing parameters to pass to an operation + * + * @example { userId: "$response.body#/id" } + * @example { limit: 10 } + */ + parameters?: Record; - /** - * A literal value or expression to use as a request body when calling the target operation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - requestBody} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - requestBody} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - requestBody} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - requestBody} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - requestBody} | - * @property `requestBody` - Optional A literal value or expression to use as a request body - * - * @example { name: "John Doe" } - * @example "$request.body#/user" - */ - requestBody?: unknown; + /** + * A literal value or expression to use as a request body when calling the target operation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - requestBody} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - requestBody} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - requestBody} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - requestBody} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - requestBody} | + * @property `requestBody` - Optional A literal value or expression to use as a request body + * + * @example { name: "John Doe" } + * @example "$request.body#/user" + */ + requestBody?: unknown; - /** - * A description of the link. CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - description} | - * @property `description` - Optional A description of the link - * - * @example "Get user by ID" - * @example "Create a new pet" - */ - description?: string; + /** + * A description of the link. CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - description} | + * @property `description` - Optional A description of the link + * + * @example "Get user by ID" + * @example "Create a new pet" + */ + description?: string; - /** - * A server object to be used by the target operation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - server} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - server} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - server} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - server} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - server} | - * @property `server` - Optional A server object to be used by the target operation - * - * @example { url: "https://api.example.com/v1" } - */ - server?: Server; + /** + * A server object to be used by the target operation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object | OpenAPI 3.0.4 Link Object - server} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object | OpenAPI 3.0.3 Link Object - server} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object | OpenAPI 3.0.2 Link Object - server} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object | OpenAPI 3.0.1 Link Object - server} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object | OpenAPI 3.0.0 Link Object - server} | + * @property `server` - Optional A server object to be used by the target operation + * + * @example { url: "https://api.example.com/v1" } + */ + server?: Server; } /** @@ -1945,75 +1945,75 @@ export interface Link extends Extension { * ``` */ export interface Example extends Extension { - /** - * Short description for the example. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object | OpenAPI 3.0.4 Example Object - summary} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object | OpenAPI 3.0.3 Example Object - summary} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object | OpenAPI 3.0.2 Example Object - summary} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object | OpenAPI 3.0.1 Example Object - summary} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object | OpenAPI 3.0.0 Example Object - summary} | - * @property `summary` - Optional Short description for the example - * - * @example "A user example" - * @example "An error response" - */ - summary?: string; + /** + * Short description for the example. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object | OpenAPI 3.0.4 Example Object - summary} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object | OpenAPI 3.0.3 Example Object - summary} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object | OpenAPI 3.0.2 Example Object - summary} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object | OpenAPI 3.0.1 Example Object - summary} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object | OpenAPI 3.0.0 Example Object - summary} | + * @property `summary` - Optional Short description for the example + * + * @example "A user example" + * @example "An error response" + */ + summary?: string; - /** - * Long description for the example. CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object | OpenAPI 3.0.4 Example Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object | OpenAPI 3.0.3 Example Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object | OpenAPI 3.0.2 Example Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object | OpenAPI 3.0.1 Example Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object | OpenAPI 3.0.0 Example Object - description} | - * @property `description` - Optional Long description for the example - * - * @example "A complete user object with all fields populated" - * @example "An error response when the user is not found" - */ - description?: string; + /** + * Long description for the example. CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object | OpenAPI 3.0.4 Example Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object | OpenAPI 3.0.3 Example Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object | OpenAPI 3.0.2 Example Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object | OpenAPI 3.0.1 Example Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object | OpenAPI 3.0.0 Example Object - description} | + * @property `description` - Optional Long description for the example + * + * @example "A complete user object with all fields populated" + * @example "An error response when the user is not found" + */ + description?: string; - /** - * Embedded literal example. The value field and externalValue field are mutually exclusive. - * To represent examples of media types that cannot naturally represented in JSON or YAML, - * use a string value to contain the example, escaping where necessary. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object | OpenAPI 3.0.4 Example Object - value} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object | OpenAPI 3.0.3 Example Object - value} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object | OpenAPI 3.0.2 Example Object - value} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object | OpenAPI 3.0.1 Example Object - value} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object | OpenAPI 3.0.0 Example Object - value} | - * @property `value` - Optional Embedded literal example - * - * @example { name: "John Doe", email: "john@example.com" } - * @example "example string value" - */ - value?: unknown; + /** + * Embedded literal example. The value field and externalValue field are mutually exclusive. + * To represent examples of media types that cannot naturally represented in JSON or YAML, + * use a string value to contain the example, escaping where necessary. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object | OpenAPI 3.0.4 Example Object - value} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object | OpenAPI 3.0.3 Example Object - value} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object | OpenAPI 3.0.2 Example Object - value} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object | OpenAPI 3.0.1 Example Object - value} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object | OpenAPI 3.0.0 Example Object - value} | + * @property `value` - Optional Embedded literal example + * + * @example { name: "John Doe", email: "john@example.com" } + * @example "example string value" + */ + value?: unknown; - /** - * A 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. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object | OpenAPI 3.0.4 Example Object - externalValue} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object | OpenAPI 3.0.3 Example Object - externalValue} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object | OpenAPI 3.0.2 Example Object - externalValue} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object | OpenAPI 3.0.1 Example Object - externalValue} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object | OpenAPI 3.0.0 Example Object - externalValue} | - * @property `externalValue` - Optional A URL that points to the literal example - * - * @example "https://example.com/examples/user-example.json" - * @example "https://example.com/examples/error-example.xml" - */ - externalValue?: string; + /** + * A 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. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object | OpenAPI 3.0.4 Example Object - externalValue} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object | OpenAPI 3.0.3 Example Object - externalValue} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object | OpenAPI 3.0.2 Example Object - externalValue} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object | OpenAPI 3.0.1 Example Object - externalValue} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object | OpenAPI 3.0.0 Example Object - externalValue} | + * @property `externalValue` - Optional A URL that points to the literal example + * + * @example "https://example.com/examples/user-example.json" + * @example "https://example.com/examples/error-example.xml" + */ + externalValue?: string; } diff --git a/3.0/references.ts b/3.0/references.ts index f00785a..9486a8d 100644 --- a/3.0/references.ts +++ b/3.0/references.ts @@ -38,21 +38,21 @@ import type { Extension } from "./extensions"; * ``` */ export interface Reference extends Extension { - /** - * The reference string. MUST be a valid JSON Reference. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object | OpenAPI 3.0.4 Reference Object - $ref} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object | OpenAPI 3.0.3 Reference Object - $ref} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object | OpenAPI 3.0.2 Reference Object - $ref} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object | OpenAPI 3.0.1 Reference Object - $ref} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object | OpenAPI 3.0.0 Reference Object - $ref} | - * @property `$ref` - Required The reference string - * - * @example "#/components/schemas/User" - * @example "#/components/responses/NotFound" - * @example "#/components/parameters/LimitParam" - */ - $ref: string; + /** + * The reference string. MUST be a valid JSON Reference. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object | OpenAPI 3.0.4 Reference Object - $ref} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object | OpenAPI 3.0.3 Reference Object - $ref} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object | OpenAPI 3.0.2 Reference Object - $ref} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object | OpenAPI 3.0.1 Reference Object - $ref} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object | OpenAPI 3.0.0 Reference Object - $ref} | + * @property `$ref` - Required The reference string + * + * @example "#/components/schemas/User" + * @example "#/components/responses/NotFound" + * @example "#/components/parameters/LimitParam" + */ + $ref: string; } diff --git a/3.0/schema.ts b/3.0/schema.ts index da4ca15..32838b1 100644 --- a/3.0/schema.ts +++ b/3.0/schema.ts @@ -1,12 +1,12 @@ import type { - ArraySchema, - BooleanSchema, - CompositionSchema, - IntegerSchema, - NumberSchema, - ObjectSchema, - ReferenceSchema, - StringSchema, + ArraySchema, + BooleanSchema, + CompositionSchema, + IntegerSchema, + NumberSchema, + ObjectSchema, + ReferenceSchema, + StringSchema, } from "./data-types"; // Discriminator will be defined below to avoid circular reference @@ -97,14 +97,14 @@ import type { * ``` */ export type Schema = - | ReferenceSchema - | StringSchema - | NumberSchema - | IntegerSchema - | BooleanSchema - | ArraySchema - | ObjectSchema - | CompositionSchema; + | ReferenceSchema + | StringSchema + | NumberSchema + | IntegerSchema + | BooleanSchema + | ArraySchema + | ObjectSchema + | CompositionSchema; /** * ----- @@ -160,40 +160,40 @@ export type Schema = * ``` */ export interface Discriminator { - /** - * The name of the property in the schema that is used as a discriminator. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object | OpenAPI 3.0.4 Discriminator Object - propertyName} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object | OpenAPI 3.0.3 Discriminator Object - propertyName} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object | OpenAPI 3.0.2 Discriminator Object - propertyName} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object | OpenAPI 3.0.1 Discriminator Object - propertyName} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object | OpenAPI 3.0.0 Discriminator Object - propertyName} | - * @property `propertyName` - Required The name of the property in the schema that is used as a discriminator - * - * @example "petType" - * @example "type" - * @example "kind" - */ - propertyName: string; + /** + * The name of the property in the schema that is used as a discriminator. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object | OpenAPI 3.0.4 Discriminator Object - propertyName} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object | OpenAPI 3.0.3 Discriminator Object - propertyName} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object | OpenAPI 3.0.2 Discriminator Object - propertyName} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object | OpenAPI 3.0.1 Discriminator Object - propertyName} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object | OpenAPI 3.0.0 Discriminator Object - propertyName} | + * @property `propertyName` - Required The name of the property in the schema that is used as a discriminator + * + * @example "petType" + * @example "type" + * @example "kind" + */ + propertyName: string; - /** - * An object to hold mappings between payload values and schema names or references. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object | OpenAPI 3.0.4 Discriminator Object - mapping} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object | OpenAPI 3.0.3 Discriminator Object - mapping} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object | OpenAPI 3.0.2 Discriminator Object - mapping} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object | OpenAPI 3.0.1 Discriminator Object - mapping} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object | OpenAPI 3.0.0 Discriminator Object - mapping} | - * @property `mapping` - Optional An object to hold mappings between payload values and schema names or references - * - * @example { "dog": "Dog", "cat": "Cat" } - * @example { "admin": "AdminUser", "user": "RegularUser" } - */ - mapping?: Record; + /** + * An object to hold mappings between payload values and schema names or references. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object | OpenAPI 3.0.4 Discriminator Object - mapping} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object | OpenAPI 3.0.3 Discriminator Object - mapping} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object | OpenAPI 3.0.2 Discriminator Object - mapping} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object | OpenAPI 3.0.1 Discriminator Object - mapping} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object | OpenAPI 3.0.0 Discriminator Object - mapping} | + * @property `mapping` - Optional An object to hold mappings between payload values and schema names or references + * + * @example { "dog": "Dog", "cat": "Cat" } + * @example { "admin": "AdminUser", "user": "RegularUser" } + */ + mapping?: Record; } /** diff --git a/3.0/security.ts b/3.0/security.ts index 708671c..bc2827b 100644 --- a/3.0/security.ts +++ b/3.0/security.ts @@ -90,142 +90,142 @@ import type { Extension } from "./extensions"; * ``` */ export interface SecurityScheme extends Extension { - /** - * The type of the security scheme. This field is required. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - type} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - type} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - type} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - type} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - type} | - * @property `type` - Required The type of the security scheme - * - * @example "apiKey" - * @example "http" - * @example "oauth2" - * @example "openIdConnect" - */ - type: "apiKey" | "http" | "oauth2" | "openIdConnect"; + /** + * The type of the security scheme. This field is required. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - type} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - type} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - type} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - type} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - type} | + * @property `type` - Required The type of the security scheme + * + * @example "apiKey" + * @example "http" + * @example "oauth2" + * @example "openIdConnect" + */ + type: "apiKey" | "http" | "oauth2" | "openIdConnect"; - /** - * A short description for security scheme. CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - description} | - * @property `description` - Optional A short description for security scheme - * - * @example "API key authentication" - * @example "OAuth 2.0 authentication" - */ - description?: string; + /** + * A short description for security scheme. CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - description} | + * @property `description` - Optional A short description for security scheme + * + * @example "API key authentication" + * @example "OAuth 2.0 authentication" + */ + description?: string; - /** - * The name of the header, query or cookie parameter to be used. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - name} | - * @property `name` - Optional The name of the header, query or cookie parameter to be used - * - * @example "X-API-Key" - * @example "Authorization" - */ - name?: string; + /** + * The name of the header, query or cookie parameter to be used. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - name} | + * @property `name` - Optional The name of the header, query or cookie parameter to be used + * + * @example "X-API-Key" + * @example "Authorization" + */ + name?: string; - /** - * The location of the API key. Valid values are "query", "header" or "cookie". - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - in} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - in} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - in} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - in} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - in} | - * @property `in` - Optional The location of the API key - * - * @example "query" - * @example "header" - * @example "cookie" - */ - in?: "query" | "header" | "cookie"; + /** + * The location of the API key. Valid values are "query", "header" or "cookie". + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - in} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - in} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - in} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - in} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - in} | + * @property `in` - Optional The location of the API key + * + * @example "query" + * @example "header" + * @example "cookie" + */ + in?: "query" | "header" | "cookie"; - /** - * The name of the HTTP Authorization scheme to be used in the Authorization header. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - scheme} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - scheme} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - scheme} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - scheme} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - scheme} | - * @property `scheme` - Optional The name of the HTTP Authorization scheme to be used in the Authorization header - * - * @example "bearer" - * @example "basic" - */ - scheme?: string; + /** + * The name of the HTTP Authorization scheme to be used in the Authorization header. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - scheme} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - scheme} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - scheme} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - scheme} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - scheme} | + * @property `scheme` - Optional The name of the HTTP Authorization scheme to be used in the Authorization header + * + * @example "bearer" + * @example "basic" + */ + scheme?: string; - /** - * A hint to the client to identify how the bearer token is formatted. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - bearerFormat} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - bearerFormat} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - bearerFormat} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - bearerFormat} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - bearerFormat} | - * @property `bearerFormat` - Optional A hint to the client to identify how the bearer token is formatted - * - * @example "JWT" - * @example "Bearer" - */ - bearerFormat?: string; + /** + * A hint to the client to identify how the bearer token is formatted. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - bearerFormat} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - bearerFormat} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - bearerFormat} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - bearerFormat} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - bearerFormat} | + * @property `bearerFormat` - Optional A hint to the client to identify how the bearer token is formatted + * + * @example "JWT" + * @example "Bearer" + */ + bearerFormat?: string; - /** - * An object containing configuration information for the flow types supported. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - flows} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - flows} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - flows} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - flows} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - flows} | - * @property `flows` - Optional An object containing configuration information for the flow types supported - * - * @example { authorizationCode: { authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token" } } - */ - flows?: OAuthFlows; + /** + * An object containing configuration information for the flow types supported. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - flows} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - flows} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - flows} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - flows} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - flows} | + * @property `flows` - Optional An object containing configuration information for the flow types supported + * + * @example { authorizationCode: { authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token" } } + */ + flows?: OAuthFlows; - /** - * OpenId Connect URL to discover OAuth2 configuration values. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl} | - * @property `openIdConnectUrl` - Optional OpenId Connect URL to discover OAuth2 configuration values - * - * @example "https://example.com/.well-known/openid_configuration" - */ - openIdConnectUrl?: string; + /** + * OpenId Connect URL to discover OAuth2 configuration values. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object | OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object | OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object | OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object | OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object | OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl} | + * @property `openIdConnectUrl` - Optional OpenId Connect URL to discover OAuth2 configuration values + * + * @example "https://example.com/.well-known/openid_configuration" + */ + openIdConnectUrl?: string; } /** @@ -297,69 +297,69 @@ export interface SecurityScheme extends Extension { * ``` */ export interface OAuthFlows extends Extension { - /** - * Configuration for the OAuth Implicit flow. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object | OpenAPI 3.0.4 OAuth Flows Object - implicit} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object | OpenAPI 3.0.3 OAuth Flows Object - implicit} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object | OpenAPI 3.0.2 OAuth Flows Object - implicit} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object | OpenAPI 3.0.1 OAuth Flows Object - implicit} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object | OpenAPI 3.0.0 OAuth Flows Object - implicit} | - * @property `implicit` - Optional Configuration for the OAuth Implicit flow - * - * @example { authorizationUrl: "https://example.com/oauth/authorize", scopes: { read: "Read access" } } - */ - implicit?: OAuthFlow; + /** + * Configuration for the OAuth Implicit flow. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object | OpenAPI 3.0.4 OAuth Flows Object - implicit} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object | OpenAPI 3.0.3 OAuth Flows Object - implicit} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object | OpenAPI 3.0.2 OAuth Flows Object - implicit} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object | OpenAPI 3.0.1 OAuth Flows Object - implicit} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object | OpenAPI 3.0.0 OAuth Flows Object - implicit} | + * @property `implicit` - Optional Configuration for the OAuth Implicit flow + * + * @example { authorizationUrl: "https://example.com/oauth/authorize", scopes: { read: "Read access" } } + */ + implicit?: OAuthFlow; - /** - * Configuration for the OAuth Resource Owner Password flow. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object | OpenAPI 3.0.4 OAuth Flows Object - password} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object | OpenAPI 3.0.3 OAuth Flows Object - password} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object | OpenAPI 3.0.2 OAuth Flows Object - password} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object | OpenAPI 3.0.1 OAuth Flows Object - password} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object | OpenAPI 3.0.0 OAuth Flows Object - password} | - * @property `password` - Optional Configuration for the OAuth Resource Owner Password flow - * - * @example { tokenUrl: "https://example.com/oauth/token", scopes: { read: "Read access" } } - */ - password?: OAuthFlow; + /** + * Configuration for the OAuth Resource Owner Password flow. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object | OpenAPI 3.0.4 OAuth Flows Object - password} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object | OpenAPI 3.0.3 OAuth Flows Object - password} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object | OpenAPI 3.0.2 OAuth Flows Object - password} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object | OpenAPI 3.0.1 OAuth Flows Object - password} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object | OpenAPI 3.0.0 OAuth Flows Object - password} | + * @property `password` - Optional Configuration for the OAuth Resource Owner Password flow + * + * @example { tokenUrl: "https://example.com/oauth/token", scopes: { read: "Read access" } } + */ + password?: OAuthFlow; - /** - * Configuration for the OAuth Client Credentials flow. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object | OpenAPI 3.0.4 OAuth Flows Object - clientCredentials} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object | OpenAPI 3.0.3 OAuth Flows Object - clientCredentials} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object | OpenAPI 3.0.2 OAuth Flows Object - clientCredentials} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object | OpenAPI 3.0.1 OAuth Flows Object - clientCredentials} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object | OpenAPI 3.0.0 OAuth Flows Object - clientCredentials} | - * @property `clientCredentials` - Optional Configuration for the OAuth Client Credentials flow - * - * @example { tokenUrl: "https://example.com/oauth/token", scopes: { read: "Read access" } } - */ - clientCredentials?: OAuthFlow; + /** + * Configuration for the OAuth Client Credentials flow. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object | OpenAPI 3.0.4 OAuth Flows Object - clientCredentials} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object | OpenAPI 3.0.3 OAuth Flows Object - clientCredentials} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object | OpenAPI 3.0.2 OAuth Flows Object - clientCredentials} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object | OpenAPI 3.0.1 OAuth Flows Object - clientCredentials} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object | OpenAPI 3.0.0 OAuth Flows Object - clientCredentials} | + * @property `clientCredentials` - Optional Configuration for the OAuth Client Credentials flow + * + * @example { tokenUrl: "https://example.com/oauth/token", scopes: { read: "Read access" } } + */ + clientCredentials?: OAuthFlow; - /** - * Configuration for the OAuth Authorization Code flow. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object | OpenAPI 3.0.4 OAuth Flows Object - authorizationCode} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object | OpenAPI 3.0.3 OAuth Flows Object - authorizationCode} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object | OpenAPI 3.0.2 OAuth Flows Object - authorizationCode} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object | OpenAPI 3.0.1 OAuth Flows Object - authorizationCode} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object | OpenAPI 3.0.0 OAuth Flows Object - authorizationCode} | - * @property `authorizationCode` - Optional Configuration for the OAuth Authorization Code flow - * - * @example { authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token", scopes: { read: "Read access" } } - */ - authorizationCode?: OAuthFlow; + /** + * Configuration for the OAuth Authorization Code flow. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object | OpenAPI 3.0.4 OAuth Flows Object - authorizationCode} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object | OpenAPI 3.0.3 OAuth Flows Object - authorizationCode} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object | OpenAPI 3.0.2 OAuth Flows Object - authorizationCode} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object | OpenAPI 3.0.1 OAuth Flows Object - authorizationCode} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object | OpenAPI 3.0.0 OAuth Flows Object - authorizationCode} | + * @property `authorizationCode` - Optional Configuration for the OAuth Authorization Code flow + * + * @example { authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token", scopes: { read: "Read access" } } + */ + authorizationCode?: OAuthFlow; } /** @@ -433,73 +433,73 @@ export interface OAuthFlows extends Extension { * ``` */ export interface OAuthFlow extends Extension { - /** - * The authorization URL to be used for this flow. This MUST be in the form of a URL. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object | OpenAPI 3.0.4 OAuth Flow Object - authorizationUrl} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object | OpenAPI 3.0.3 OAuth Flow Object - authorizationUrl} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object | OpenAPI 3.0.2 OAuth Flow Object - authorizationUrl} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object | OpenAPI 3.0.1 OAuth Flow Object - authorizationUrl} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object | OpenAPI 3.0.0 OAuth Flow Object - authorizationUrl} | - * @property `authorizationUrl` - Optional The authorization URL to be used for this flow - * - * @example "https://example.com/oauth/authorize" - * @example "https://api.example.com/oauth/authorize" - */ - authorizationUrl?: string; + /** + * The authorization URL to be used for this flow. This MUST be in the form of a URL. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object | OpenAPI 3.0.4 OAuth Flow Object - authorizationUrl} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object | OpenAPI 3.0.3 OAuth Flow Object - authorizationUrl} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object | OpenAPI 3.0.2 OAuth Flow Object - authorizationUrl} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object | OpenAPI 3.0.1 OAuth Flow Object - authorizationUrl} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object | OpenAPI 3.0.0 OAuth Flow Object - authorizationUrl} | + * @property `authorizationUrl` - Optional The authorization URL to be used for this flow + * + * @example "https://example.com/oauth/authorize" + * @example "https://api.example.com/oauth/authorize" + */ + authorizationUrl?: string; - /** - * The token URL to be used for this flow. This MUST be in the form of a URL. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object | OpenAPI 3.0.4 OAuth Flow Object - tokenUrl} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object | OpenAPI 3.0.3 OAuth Flow Object - tokenUrl} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object | OpenAPI 3.0.2 OAuth Flow Object - tokenUrl} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object | OpenAPI 3.0.1 OAuth Flow Object - tokenUrl} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object | OpenAPI 3.0.0 OAuth Flow Object - tokenUrl} | - * @property `tokenUrl` - Optional The token URL to be used for this flow - * - * @example "https://example.com/oauth/token" - * @example "https://api.example.com/oauth/token" - */ - tokenUrl?: string; + /** + * The token URL to be used for this flow. This MUST be in the form of a URL. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object | OpenAPI 3.0.4 OAuth Flow Object - tokenUrl} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object | OpenAPI 3.0.3 OAuth Flow Object - tokenUrl} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object | OpenAPI 3.0.2 OAuth Flow Object - tokenUrl} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object | OpenAPI 3.0.1 OAuth Flow Object - tokenUrl} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object | OpenAPI 3.0.0 OAuth Flow Object - tokenUrl} | + * @property `tokenUrl` - Optional The token URL to be used for this flow + * + * @example "https://example.com/oauth/token" + * @example "https://api.example.com/oauth/token" + */ + tokenUrl?: string; - /** - * The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object | OpenAPI 3.0.4 OAuth Flow Object - refreshUrl} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object | OpenAPI 3.0.3 OAuth Flow Object - refreshUrl} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object | OpenAPI 3.0.2 OAuth Flow Object - refreshUrl} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object | OpenAPI 3.0.1 OAuth Flow Object - refreshUrl} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object | OpenAPI 3.0.0 OAuth Flow Object - refreshUrl} | - * @property `refreshUrl` - Optional The URL to be used for obtaining refresh tokens - * - * @example "https://example.com/oauth/refresh" - * @example "https://api.example.com/oauth/refresh" - */ - refreshUrl?: string; + /** + * The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object | OpenAPI 3.0.4 OAuth Flow Object - refreshUrl} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object | OpenAPI 3.0.3 OAuth Flow Object - refreshUrl} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object | OpenAPI 3.0.2 OAuth Flow Object - refreshUrl} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object | OpenAPI 3.0.1 OAuth Flow Object - refreshUrl} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object | OpenAPI 3.0.0 OAuth Flow Object - refreshUrl} | + * @property `refreshUrl` - Optional The URL to be used for obtaining refresh tokens + * + * @example "https://example.com/oauth/refresh" + * @example "https://api.example.com/oauth/refresh" + */ + refreshUrl?: string; - /** - * The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object | OpenAPI 3.0.4 OAuth Flow Object - scopes} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object | OpenAPI 3.0.3 OAuth Flow Object - scopes} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object | OpenAPI 3.0.2 OAuth Flow Object - scopes} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object | OpenAPI 3.0.1 OAuth Flow Object - scopes} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object | OpenAPI 3.0.0 OAuth Flow Object - scopes} | - * @property `scopes` - Required The available scopes for the OAuth2 security scheme - * - * @example { "read": "Read access", "write": "Write access" } - * @example { "admin": "Administrative access" } - */ - scopes: Record; + /** + * The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object | OpenAPI 3.0.4 OAuth Flow Object - scopes} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object | OpenAPI 3.0.3 OAuth Flow Object - scopes} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object | OpenAPI 3.0.2 OAuth Flow Object - scopes} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object | OpenAPI 3.0.1 OAuth Flow Object - scopes} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object | OpenAPI 3.0.0 OAuth Flow Object - scopes} | + * @property `scopes` - Required The available scopes for the OAuth2 security scheme + * + * @example { "read": "Read access", "write": "Write access" } + * @example { "admin": "Administrative access" } + */ + scopes: Record; } /** @@ -567,5 +567,5 @@ export interface OAuthFlow extends Extension { * ``` */ export interface SecurityRequirement { - [schemeName: string]: string[]; + [schemeName: string]: string[]; } diff --git a/3.0/servers.ts b/3.0/servers.ts index 783bac6..f31aaa5 100644 --- a/3.0/servers.ts +++ b/3.0/servers.ts @@ -75,61 +75,61 @@ import type { Extension } from "./extensions"; * ``` */ export interface Server extends Extension { - /** - * A URL to the target host. This URL supports Server Variables and MAY be relative, - * to indicate that the host location is relative to the location where the OpenAPI - * document is being served. Variable substitutions will be made when a variable - * is named in {brackets}. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object | OpenAPI 3.0.4 Server Object - url} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object | OpenAPI 3.0.3 Server Object - url} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object | OpenAPI 3.0.2 Server Object - url} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object | OpenAPI 3.0.1 Server Object - url} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object | OpenAPI 3.0.0 Server Object - url} | - * @property `url` - Required A URL to the target host - * - * @example "https://api.example.com/v1" - * @example "https://{username}.example.com:{port}/{basePath}" - * @example "/v1" - */ - url: string; + /** + * A URL to the target host. This URL supports Server Variables and MAY be relative, + * to indicate that the host location is relative to the location where the OpenAPI + * document is being served. Variable substitutions will be made when a variable + * is named in {brackets}. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object | OpenAPI 3.0.4 Server Object - url} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object | OpenAPI 3.0.3 Server Object - url} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object | OpenAPI 3.0.2 Server Object - url} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object | OpenAPI 3.0.1 Server Object - url} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object | OpenAPI 3.0.0 Server Object - url} | + * @property `url` - Required A URL to the target host + * + * @example "https://api.example.com/v1" + * @example "https://{username}.example.com:{port}/{basePath}" + * @example "/v1" + */ + url: string; - /** - * An optional string describing the host designated by the URL. - * CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object | OpenAPI 3.0.4 Server Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object | OpenAPI 3.0.3 Server Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object | OpenAPI 3.0.2 Server Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object | OpenAPI 3.0.1 Server Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object | OpenAPI 3.0.0 Server Object - description} | - * @property `description` - Optional An optional string describing the host designated by the URL - * - * @example "Development server" - * @example "Production server" - */ - description?: string; + /** + * An optional string describing the host designated by the URL. + * CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object | OpenAPI 3.0.4 Server Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object | OpenAPI 3.0.3 Server Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object | OpenAPI 3.0.2 Server Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object | OpenAPI 3.0.1 Server Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object | OpenAPI 3.0.0 Server Object - description} | + * @property `description` - Optional An optional string describing the host designated by the URL + * + * @example "Development server" + * @example "Production server" + */ + description?: string; - /** - * A map between a variable name and its value. The value is used for substitution - * in the server's URL template. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object | OpenAPI 3.0.4 Server Object - variables} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object | OpenAPI 3.0.3 Server Object - variables} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object | OpenAPI 3.0.2 Server Object - variables} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object | OpenAPI 3.0.1 Server Object - variables} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object | OpenAPI 3.0.0 Server Object - variables} | - * @property `variables` - Optional A map between a variable name and its value - * - * @example { username: { default: "demo" }, port: { default: "8080" } } - */ - variables?: Record; + /** + * A map between a variable name and its value. The value is used for substitution + * in the server's URL template. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object | OpenAPI 3.0.4 Server Object - variables} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object | OpenAPI 3.0.3 Server Object - variables} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object | OpenAPI 3.0.2 Server Object - variables} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object | OpenAPI 3.0.1 Server Object - variables} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object | OpenAPI 3.0.0 Server Object - variables} | + * @property `variables` - Optional A map between a variable name and its value + * + * @example { username: { default: "demo" }, port: { default: "8080" } } + */ + variables?: Record; } /** @@ -196,56 +196,56 @@ export interface Server extends Extension { * ``` */ export interface ServerVariable extends Extension { - /** - * An enumeration of string values to be used if the substitution options are from a limited set. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object | OpenAPI 3.0.4 Server Variable Object - enum} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object | OpenAPI 3.0.3 Server Variable Object - enum} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object | OpenAPI 3.0.2 Server Variable Object - enum} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object | OpenAPI 3.0.1 Server Variable Object - enum} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object | OpenAPI 3.0.0 Server Variable Object - enum} | - * @property `enum` - Optional An enumeration of string values to be used if the substitution options are from a limited set - * - * @example ["8443", "443"] - * @example ["v1", "v2", "v3"] - */ - enum?: string[]; + /** + * An enumeration of string values to be used if the substitution options are from a limited set. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object | OpenAPI 3.0.4 Server Variable Object - enum} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object | OpenAPI 3.0.3 Server Variable Object - enum} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object | OpenAPI 3.0.2 Server Variable Object - enum} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object | OpenAPI 3.0.1 Server Variable Object - enum} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object | OpenAPI 3.0.0 Server Variable Object - enum} | + * @property `enum` - Optional An enumeration of string values to be used if the substitution options are from a limited set + * + * @example ["8443", "443"] + * @example ["v1", "v2", "v3"] + */ + enum?: string[]; - /** - * The default value to use for substitution, and to send, if an alternate value is not supplied. - * Unlike the Schema Object's default, this value MUST be provided by the consumer. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object | OpenAPI 3.0.4 Server Variable Object - default} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object | OpenAPI 3.0.3 Server Variable Object - default} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object | OpenAPI 3.0.2 Server Variable Object - default} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object | OpenAPI 3.0.1 Server Variable Object - default} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object | OpenAPI 3.0.0 Server Variable Object - default} | - * @property `default` - Required The default value to use for substitution - * - * @example "demo" - * @example "8443" - * @example "v2" - */ - default: string; + /** + * The default value to use for substitution, and to send, if an alternate value is not supplied. + * Unlike the Schema Object's default, this value MUST be provided by the consumer. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object | OpenAPI 3.0.4 Server Variable Object - default} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object | OpenAPI 3.0.3 Server Variable Object - default} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object | OpenAPI 3.0.2 Server Variable Object - default} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object | OpenAPI 3.0.1 Server Variable Object - default} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object | OpenAPI 3.0.0 Server Variable Object - default} | + * @property `default` - Required The default value to use for substitution + * + * @example "demo" + * @example "8443" + * @example "v2" + */ + default: string; - /** - * An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object | OpenAPI 3.0.4 Server Variable Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object | OpenAPI 3.0.3 Server Variable Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object | OpenAPI 3.0.2 Server Variable Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object | OpenAPI 3.0.1 Server Variable Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object | OpenAPI 3.0.0 Server Variable Object - description} | - * @property `description` - Optional An optional description for the server variable - * - * @example "this value is assigned by the service provider" - * @example "Port number for the server" - */ - description?: string; + /** + * An optional description for the server variable. CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object | OpenAPI 3.0.4 Server Variable Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object | OpenAPI 3.0.3 Server Variable Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object | OpenAPI 3.0.2 Server Variable Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object | OpenAPI 3.0.1 Server Variable Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object | OpenAPI 3.0.0 Server Variable Object - description} | + * @property `description` - Optional An optional description for the server variable + * + * @example "this value is assigned by the service provider" + * @example "Port number for the server" + */ + description?: string; } diff --git a/3.0/spec.ts b/3.0/spec.ts index 274af52..851652c 100644 --- a/3.0/spec.ts +++ b/3.0/spec.ts @@ -103,153 +103,153 @@ import type { Tag } from "./tags"; * ``` */ export type Specification = { - /** - * Specifies the OpenAPI specification version being used. - * Must be "3.0.0" for this specification. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - openapi} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - openapi} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - openapi} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - openapi} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - openapi} | - * - * @property `openapi` - Required The OpenAPI specification version - */ - openapi: "3.0.0" | "3.0.1" | "3.0.2" | "3.0.3" | "3.0.4"; + /** + * Specifies the OpenAPI specification version being used. + * Must be "3.0.0" for this specification. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - openapi} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - openapi} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - openapi} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - openapi} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - openapi} | + * + * @property `openapi` - Required The OpenAPI specification version + */ + openapi: "3.0.0" | "3.0.1" | "3.0.2" | "3.0.3" | "3.0.4"; - /** - * Provides metadata about the API. The metadata can be used by the clients - * if needed, and can be presented in the OpenAPI-UI for convenience. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - info} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - info} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - info} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - info} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - info} | - * - * @property `info` - Required Metadata about the API - */ - info: Info; + /** + * Provides metadata about the API. The metadata can be used by the clients + * if needed, and can be presented in the OpenAPI-UI for convenience. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - info} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - info} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - info} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - info} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - info} | + * + * @property `info` - Required Metadata about the API + */ + info: Info; - /** - * An array of Server Objects, which provide connectivity information to a target server. - * If the servers property is not provided, or is an empty array, the default value - * would be a Server Object with a url value of "/". - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - servers} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - servers} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - servers} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - servers} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - servers} | - * - * @property `servers` - Optional Array of server objects - * - * @example [{ url: "https://api.example.com/v1", description: "Production server" }] - * @example [{ url: "https://staging-api.example.com/v1", description: "Staging server" }] - */ - servers?: Server[]; + /** + * An array of Server Objects, which provide connectivity information to a target server. + * If the servers property is not provided, or is an empty array, the default value + * would be a Server Object with a url value of "/". + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - servers} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - servers} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - servers} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - servers} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - servers} | + * + * @property `servers` - Optional Array of server objects + * + * @example [{ url: "https://api.example.com/v1", description: "Production server" }] + * @example [{ url: "https://staging-api.example.com/v1", description: "Staging server" }] + */ + servers?: Server[]; - /** - * The available paths and operations for the API. This is the root of the - * Path Item Object. It does not define a path or a basePath, they are defined - * in the Paths Object. A relative path to an individual endpoint. The field - * name MUST begin with a slash. The path is appended to the basePath in order - * to construct the full URL. Path templating is allowed. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - paths} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - paths} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - paths} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - paths} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - paths} | - * - * @property `paths` - Required Available paths and operations for the API - * - * @example { "/users": { get: { ... } } } - * @example { "/users/{id}": { get: { ... } } } - */ - paths: Paths; + /** + * The available paths and operations for the API. This is the root of the + * Path Item Object. It does not define a path or a basePath, they are defined + * in the Paths Object. A relative path to an individual endpoint. The field + * name MUST begin with a slash. The path is appended to the basePath in order + * to construct the full URL. Path templating is allowed. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - paths} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - paths} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - paths} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - paths} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - paths} | + * + * @property `paths` - Required Available paths and operations for the API + * + * @example { "/users": { get: { ... } } } + * @example { "/users/{id}": { get: { ... } } } + */ + paths: Paths; - /** - * An element to hold various schemas for the specification. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - components} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - components} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - components} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - components} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - components} | - * - * @property `components` - Optional Reusable objects for different aspects of the OAS - * - * @example { schemas: { User: { type: "object", properties: { ... } } } } - */ - components?: Components; + /** + * An element to hold various schemas for the specification. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - components} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - components} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - components} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - components} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - components} | + * + * @property `components` - Optional Reusable objects for different aspects of the OAS + * + * @example { schemas: { User: { type: "object", properties: { ... } } } } + */ + components?: Components; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - security} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - security} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - security} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - security} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - security} | - * - * @property `security` - Optional Security mechanisms for the API - * - * @example [{ "api_key": [] }] - * @example [{ "oauth2": ["read", "write"] }] - */ - security?: SecurityRequirement[]; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - security} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - security} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - security} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - security} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - security} | + * + * @property `security` - Optional Security mechanisms for the API + * + * @example [{ "api_key": [] }] + * @example [{ "oauth2": ["read", "write"] }] + */ + security?: SecurityRequirement[]; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - tags} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - tags} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - tags} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - tags} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - tags} | - * - * @property `tags` - Optional List of tags with additional metadata - * - * @example [{ name: "users", description: "User management" }] - */ - tags?: Tag[]; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - tags} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - tags} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - tags} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - tags} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - tags} | + * + * @property `tags` - Optional List of tags with additional metadata + * + * @example [{ name: "users", description: "User management" }] + */ + tags?: Tag[]; - /** - * Additional external documentation. - * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - externalDocs} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - externalDocs} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - externalDocs} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - externalDocs} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - externalDocs} | - * - * @property `externalDocs` - Optional Additional external documentation - * - * @example { description: "Find out more about our API", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation. + * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object | OpenAPI 3.0.4 Specification - externalDocs} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object | OpenAPI 3.0.3 Specification - externalDocs} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object | OpenAPI 3.0.2 Specification - externalDocs} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object | OpenAPI 3.0.1 Specification - externalDocs} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object | OpenAPI 3.0.0 Specification - externalDocs} | + * + * @property `externalDocs` - Optional Additional external documentation + * + * @example { description: "Find out more about our API", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; } & Extension; diff --git a/3.0/status.ts b/3.0/status.ts index dd1f491..c617eab 100644 --- a/3.0/status.ts +++ b/3.0/status.ts @@ -11,989 +11,989 @@ import type { Response } from "./paths"; * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html | RFC 9110: HTTP Semantics} */ export interface ResponsesMap { - //#region Family Codes - - /** 1xx — Informational - * - * Indicates that the request was received and the server is continuing to process it. - * - * Used for provisional responses that indicate the server has received the request and is continuing to process it. These responses are typically used for status updates during long-running operations or to indicate that the server is ready to receive additional data. - * - * The client should continue waiting for the final response. These are provisional responses and the client should not consider the request complete until receiving a final status code. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "1xx"?: Response; - - /** 2xx — Success - * - * Indicates that the request was successfully received, understood, and accepted. - * - * Used for successful operations where the request was processed successfully and the response contains the requested data or indicates successful completion of the operation. - * - * The operation completed successfully. The response body typically contains the requested data or confirmation of the successful operation. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "2xx"?: Response; - - /** 3xx — Redirection - * - * Indicates that further action needs to be taken by the client to complete the request. - * - * Used when the client needs to take additional action to complete the request, such as following a redirect, providing authentication, or accessing the resource at a different location. - * - * The client needs to take additional action to complete the request. This may involve following a redirect, providing authentication, or accessing the resource at a different location. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "3xx"?: Response; - - /** 4xx — Client Error - * - * Indicates that the request contains bad syntax or cannot be fulfilled by the server. - * - * Used when the client has sent an invalid request, such as malformed syntax, invalid parameters, authentication failures, or requests for non-existent resources. - * - * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "4xx"?: Response; - - /** 5xx — Server Error - * - * Indicates that the server failed to fulfill a valid request. - * - * Used when the server encounters an error while processing a valid request, such as internal server errors, service unavailability, or gateway timeouts. - * - * The server encountered an error while processing the request. The client should retry the request later, as this is typically a temporary issue. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "5xx"?: Response; - - //#endregion - - //#region 1xx — Informational - - /** 100 Continue - * - * Indicates that the initial part of the request has been received and the client should continue with the request. - * - * The server has received the request headers and the client should proceed to send the request body. - * - * Used in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns. - * - * The server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue | RFC 9110 §15.2.1} - */ - "100"?: Response; - - /** 101 Switching Protocols - * - * Indicates that the server is switching protocols as requested by the client. - * - * The server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols. - * - * Primarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios. - * - * The connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols | RFC 9110 §15.2.2} - */ - "101"?: Response; - - /** 102 Processing - * - * Indicates that the server has received and is processing the request, but no response is available yet. - * - * The server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting. - * - * Primarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods. - * - * The request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2518 | RFC 2518 (WebDAV)} - */ - "102"?: Response; - - /** 103 Early Hints - * - * Provides early hints about the response that will be sent, allowing the client to start processing before the full response is ready. - * - * The server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early. - * - * Used for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance. - * - * The client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc8297 | RFC 8297} - */ - "103"?: Response; - - /** 104 Upload Resumption Supported — TEMPORARY - * - * Indicates that the server supports resumable uploads for the requested resource. - * - * The server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off. - * - * Used in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste. - * - * The client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions. - * - * @note Temporary registration; see IANA entry for current status/expiry. - * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05 | draft-ietf-httpbis-resumable-upload-05} - * @see {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | IANA registry} - */ - "104"?: Response; - - //#endregion - - //#region 2xx — Success - - /** 200 OK - * - * Indicates that the request has succeeded and the response contains the requested data. - * - * The request was processed successfully and the response body contains the requested resource or data. - * - * The most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return. - * - * The operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok | RFC 9110 §15.3.1} - */ - "200"?: Response; - - /** 201 Created - * - * Indicates that the request has succeeded and a new resource has been created as a result. - * - * The request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource. - * - * Used for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations. - * - * A new resource was successfully created and the response contains information about the created resource, typically including its ID and location. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created | RFC 9110 §15.3.2} - */ - "201"?: Response; - - /** 202 Accepted - * - * Indicates that the request has been accepted for processing, but the processing has not been completed. - * - * The request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed. - * - * Used for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone. - * - * The request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted | RFC 9110 §15.3.3} - */ - "202"?: Response; - - /** 203 Non-Authoritative Information - * - * Indicates that the request was successful, but the information returned is from a transformed or cached version of the original resource. - * - * The response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version. - * - * Used when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware. - * - * The request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-informat | RFC 9110 §15.3.4} - */ - "203"?: Response; - - /** 204 No Content - * - * Indicates that the request has succeeded but there is no content to return in the response body. - * - * The request was processed successfully but the response body is intentionally empty. The client should not expect any content. - * - * Used for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data. - * - * The operation completed successfully but no data is returned. The client should not attempt to parse a response body. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content | RFC 9110 §15.3.5} - */ - "204"?: Response; - - /** 205 Reset Content - * - * Indicates that the request has succeeded and the client should reset the document view that caused the request to be sent. - * - * The request was processed successfully and the client should clear any form data or reset the user interface state. - * - * Used in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations. - * - * The operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content | RFC 9110 §15.3.6} - */ - "205"?: Response; - - /** 206 Partial Content - * - * Indicates that the server is delivering only part of the resource due to a range request. - * - * The request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered. - * - * Used for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads. - * - * The response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content | RFC 9110 §15.3.7} - */ - "206"?: Response; - - /** 207 Multi-Status - * - * Indicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body. - * - * The response contains multiple status codes for different operations, typically in XML format with individual operation results. - * - * Used in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms. - * - * Multiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "207"?: Response; - - /** 208 Already Reported - * - * Indicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again. - * - * Used in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported. - * - * Used in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations. - * - * The information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} - */ - "208"?: Response; - - /** 226 IM Used - * - * Indicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. - * - * The response represents the result of applying instance manipulations (like delta encoding) to the current resource instance. - * - * Used in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission. - * - * The response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc3229 | RFC 3229} - */ - "226"?: Response; - - //#endregion - - //#region 3xx — Redirection - - /** 300 Multiple Choices - * - * Indicates that the request has multiple possible responses and the client should choose one. - * - * The server has multiple representations of the requested resource and the client must choose which one to use. - * - * Used when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics. - * - * The client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices | RFC 9110 §15.4.1} - */ - "300"?: Response; - - /** 301 Moved Permanently - * - * Indicates that the requested resource has been permanently moved to a new location. - * - * The resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header. - * - * Used when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches. - * - * The resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently | RFC 9110 §15.4.2} - */ - "301"?: Response; - - /** 302 Found - * - * Indicates that the requested resource has been temporarily moved to a different location. - * - * The resource is temporarily available at a different URL, but the original URL should continue to be used for future requests. - * - * Used for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid. - * - * The resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found | RFC 9110 §15.4.3} - */ - "302"?: Response; - - /** 303 See Other - * - * Indicates that the response to the request can be found at a different URL and should be retrieved using a GET request. - * - * The request was processed but the response is available at a different location, and the client should use GET to retrieve it. - * - * Used in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions. - * - * The client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other | RFC 9110 §15.4.4} - */ - "303"?: Response; - - /** 304 Not Modified - * - * Indicates that the resource has not been modified since the last request, so the cached version can be used. - * - * The resource has not changed since the last request, and the client can use its cached version. No response body is included. - * - * Used for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer. - * - * The resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified | RFC 9110 §15.4.5} - */ - "304"?: Response; - - /** 305 Use Proxy - * - * Indicates that the requested resource must be accessed through the proxy specified in the Location header. - * - * The client must use the specified proxy to access the resource. This response is rarely used in modern web applications. - * - * Used in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development. - * - * The client should use the specified proxy to access the resource. This is rarely encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy | RFC 9110 §15.4.6} - */ - "305"?: Response; - - /** 306 (Unused) - * - * This status code is reserved and not used in current HTTP specifications. - * - * This status code was previously used but is now reserved and should not be used in new implementations. - * - * Not used in modern web applications. This code is reserved and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-306-unused | RFC 9110 §15.4.7} - */ - "306"?: Response; - - /** 307 Temporary Redirect - * - * Indicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved. - * - * The resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location. - * - * Used for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated. - * - * The resource is temporarily at a different location and the client should repeat the same request method to the new URL. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect | RFC 9110 §15.4.8} - */ - "307"?: Response; - - /** 308 Permanent Redirect - * - * Indicates that the requested resource has been permanently moved to a different location, and the request method should be preserved. - * - * The resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method. - * - * Used for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations. - * - * The resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect | RFC 9110 §15.4.9} - */ - "308"?: Response; - - //#endregion - - //#region 4xx — Client Error - - /** 400 Bad Request - * - * Indicates that the server cannot process the request due to a client error. - * - * The request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process. - * - * Used for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios. - * - * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request | RFC 9110 §15.5.1} - */ - "400"?: Response; - - /** 401 Unauthorized - * - * Indicates that the request requires authentication and the client has not provided valid credentials. - * - * The request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient. - * - * Used when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows. - * - * The client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized | RFC 9110 §15.5.2} - */ - "401"?: Response; - - /** 402 Payment Required - * - * Indicates that the request requires payment before it can be processed. - * - * The request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems. - * - * Used in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services. - * - * The client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required | RFC 9110 §15.5.3} - */ - "402"?: Response; - - /** 403 Forbidden - * - * Indicates that the server understood the request but refuses to authorize it. - * - * The client is authenticated but does not have permission to access the requested resource or perform the requested action. - * - * Used when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios. - * - * The client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden | RFC 9110 §15.5.4} - */ - "403"?: Response; - - /** 404 Not Found - * - * Indicates that the requested resource could not be found on the server. - * - * The server cannot find the requested resource at the specified URL, or the resource does not exist. - * - * Used when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints. - * - * The requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found | RFC 9110 §15.5.5} - */ - "404"?: Response; - - /** 405 Method Not Allowed - * - * Indicates that the HTTP method used in the request is not allowed for the requested resource. - * - * The resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource. - * - * Used when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design. - * - * The HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed | RFC 9110 §15.5.6} - */ - "405"?: Response; - - /** 406 Not Acceptable - * - * Indicates that the server cannot produce a response matching the client's Accept headers. - * - * The server cannot generate a response in any of the formats requested by the client's Accept headers. - * - * Used when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches. - * - * The server cannot provide the requested content type. The client should check the Accept headers or request a different format. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable | RFC 9110 §15.5.7} - */ - "406"?: Response; - - /** 407 Proxy Authentication Required - * - * Indicates that the client must authenticate with the proxy server before the request can be processed. - * - * The proxy server requires authentication before it will forward the request to the destination server. - * - * Used in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies. - * - * The client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-req | RFC 9110 §15.5.8} - */ - "407"?: Response; - - /** 408 Request Timeout - * - * Indicates that the server timed out while waiting for the request from the client. - * - * The server did not receive a complete request within the time it was prepared to wait. - * - * Used when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests. - * - * The request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout | RFC 9110 §15.5.9} - */ - "408"?: Response; - - /** 409 Conflict - * - * Indicates that the request conflicts with the current state of the resource. - * - * The request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification. - * - * Used when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios. - * - * The request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | RFC 9110 §15.5.10} - */ - "409"?: Response; - - /** 410 Gone - * - * Indicates that the requested resource is no longer available and will not be available again. - * - * The resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found. - * - * Used when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios. - * - * The resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone | RFC 9110 §15.5.11} - */ - "410"?: Response; - - /** 411 Length Required - * - * Indicates that the server requires a Content-Length header in the request. - * - * The server cannot process the request without knowing the exact length of the request body. - * - * Used when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints. - * - * The client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required | RFC 9110 §15.5.12} - */ - "411"?: Response; - - /** 412 Precondition Failed - * - * Indicates that one or more preconditions in the request headers were not met. - * - * The server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since. - * - * Used in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios. - * - * The preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed | RFC 9110 §15.5.13} - */ - "412"?: Response; - - /** 413 Content Too Large - * - * Indicates that the request payload is too large for the server to process. - * - * The request body exceeds the server's maximum allowed size limit. - * - * Used when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting. - * - * The request payload is too large. The client should reduce the size of the request body or split it into smaller chunks. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large | RFC 9110 §15.5.14} - */ - "413"?: Response; - - /** 414 URI Too Long - * - * Indicates that the URI provided in the request is too long for the server to process. - * - * The URL exceeds the server's maximum allowed length limit. - * - * Used when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests. - * - * The URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long | RFC 9110 §15.5.15} - */ - "414"?: Response; - - /** 415 Unsupported Media Type - * - * Indicates that the server cannot process the request because the media type is not supported. - * - * The server cannot process the request body because the Content-Type is not supported or recognized. - * - * Used when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements. - * - * The content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type | RFC 9110 §15.5.16} - */ - "415"?: Response; - - /** 416 Range Not Satisfiable - * - * Indicates that the server cannot satisfy the range request specified in the Range header. - * - * The requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests. - * - * Used when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming. - * - * The range request is not satisfiable. The client should check the range specification or request the full resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable | RFC 9110 §15.5.17} - */ - "416"?: Response; - - /** 417 Expectation Failed - * - * Indicates that the server cannot meet the requirements of the Expect header. - * - * The server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation. - * - * Used when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations. - * - * The server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed | RFC 9110 §15.5.18} - */ - "417"?: Response; - - /** 418 (Unused) - * - * This status code is reserved and not used in current HTTP specifications. - * - * This status code is reserved and should not be used in new implementations. - * - * Not used in modern web applications. This code is reserved and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-418-unused | RFC 9110 §15.5.19} - */ - "418"?: Response; - - /** 421 Misdirected Request - * - * Indicates that the request was directed to a server that is not able to produce a response. - * - * The request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems. - * - * Used in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios. - * - * The request was sent to the wrong server. The client should retry the request, which may be routed to a different server. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request | RFC 9110 §15.5.20} - */ - "421"?: Response; - - /** 422 Unprocessable Content - * - * Indicates that the request is well-formed but contains semantic errors that prevent processing. - * - * The request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations. - * - * Used for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid. - * - * The request is well-formed but contains semantic errors. The client should fix the data and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content | RFC 9110 §15.5.21} - */ - "422"?: Response; - - /** 423 Locked - * - * Indicates that the requested resource is locked and cannot be modified. - * - * The resource is locked by another process or user and cannot be accessed or modified at this time. - * - * Used in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms. - * - * The resource is locked and cannot be accessed. The client should wait and retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "423"?: Response; - - /** 424 Failed Dependency - * - * Indicates that the request failed because it depended on another request that also failed. - * - * The request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations. - * - * Used in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios. - * - * The request failed due to a dependency failure. The client should check the dependencies and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "424"?: Response; - - /** 425 Too Early - * - * Indicates that the server is unwilling to process the request because it might be replayed. - * - * The server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns. - * - * Used in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols. - * - * The server is unwilling to process the request due to replay concerns. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc8470 | RFC 8470} - */ - "425"?: Response; - - /** 426 Upgrade Required - * - * Indicates that the server requires the client to upgrade to a different protocol. - * - * The server requires the client to use a different protocol version or upgrade to a newer version to access the resource. - * - * Used when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios. - * - * The client must upgrade to a different protocol version. The response should include upgrade information. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required | RFC 9110 §15.5.22} - */ - "426"?: Response; - - /** 428 Precondition Required - * - * Indicates that the server requires the request to include certain preconditions. - * - * The server requires the client to include specific preconditions in the request headers before it will process the request. - * - * Used when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios. - * - * The server requires specific preconditions. The client should include the required preconditions and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "428"?: Response; - - /** 429 Too Many Requests - * - * Indicates that the client has sent too many requests in a given time period and should slow down. - * - * The client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets. - * - * Used for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers. - * - * The client has exceeded the rate limit and should slow down. The client should wait before retrying the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "429"?: Response; - - /** 431 Request Header Fields Too Large - * - * Indicates that the server is unwilling to process the request because the header fields are too large. - * - * The request headers exceed the server's maximum allowed size limit. - * - * Used when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data. - * - * The request headers are too large. The client should reduce the size of the headers and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "431"?: Response; - - /** 451 Unavailable For Legal Reasons - * - * Indicates that the requested resource is unavailable due to legal reasons. - * - * The resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements. - * - * Used when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services. - * - * The resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc7725 | RFC 7725} - */ - "451"?: Response; - - //#endregion - - //#region 5xx — Server Error - - /** 500 Internal Server Error - * - * Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. - * - * The server encountered an internal error or exception that prevented it from processing the request successfully. - * - * Used for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems. - * - * The server encountered an internal error. The client should retry the request later, as this is typically a temporary issue. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error | RFC 9110 §15.6.1} - */ - "500"?: Response; - - /** 501 Not Implemented - * - * Indicates that the server does not support the functionality required to fulfill the request. - * - * The server does not recognize the request method or lacks the ability to fulfill the request. - * - * Used when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented. - * - * The server does not support the requested functionality. The client should check the API documentation for supported methods and features. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented | RFC 9110 §15.6.2} - */ - "501"?: Response; - - /** 502 Bad Gateway - * - * Indicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server. - * - * The server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access. - * - * Used in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems. - * - * The gateway received an invalid response from the upstream server. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway | RFC 9110 §15.6.3} - */ - "502"?: Response; - - /** 503 Service Unavailable - * - * Indicates that the server is temporarily unable to handle the request due to maintenance or overload. - * - * The server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints. - * - * Used during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows. - * - * The server is temporarily unavailable. The client should retry the request later, often with exponential backoff. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable | RFC 9110 §15.6.4} - */ - "503"?: Response; - - /** 504 Gateway Timeout - * - * Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server. - * - * The gateway or proxy server timed out while waiting for a response from the upstream server. - * - * Used in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times. - * - * The gateway timed out waiting for the upstream server. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout | RFC 9110 §15.6.5} - */ - "504"?: Response; - - /** 505 HTTP Version Not Supported - * - * Indicates that the server does not support the HTTP protocol version used in the request. - * - * The server does not support the HTTP protocol version specified in the request. - * - * Used when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios. - * - * The server does not support the HTTP version used in the request. The client should use a supported HTTP version. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-supporte | RFC 9110 §15.6.6} - */ - "505"?: Response; - - /** 506 Variant Also Negotiates - * - * Indicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation. - * - * The server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop. - * - * Used in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations. - * - * The server has a configuration error in content negotiation. The client should contact the server administrator. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2295 | RFC 2295} - */ - "506"?: Response; - - /** 507 Insufficient Storage - * - * Indicates that the server is unable to store the representation needed to complete the request. - * - * The server cannot store the representation required to complete the request, typically due to storage space limitations. - * - * Used in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms. - * - * The server cannot store the required representation. The client should check storage availability and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "507"?: Response; - - /** 508 Loop Detected - * - * Indicates that the server detected an infinite loop while processing the request. - * - * The server detected an infinite loop in the request processing, typically in WebDAV operations. - * - * Used in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios. - * - * The server detected an infinite loop. The client should check the request for circular references and retry. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} - */ - "508"?: Response; - - /** 510 Not Extended — OBSOLETED - * - * This status code is obsolete and should not be used in modern implementations. - * - * This status code was used for HTTP extensions but is now obsolete and should not be used. - * - * Not used in modern web applications. This code is obsolete and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2774 | RFC 2774 (Historic)} - * @see {@link https://datatracker.ietf.org/doc/status-change-http-experiments-to-historic/ | IETF: Status change of HTTP experiments to Historic} - */ - "510"?: Response; - - /** 511 Network Authentication Required - * - * Indicates that the client needs to authenticate to gain network access. - * - * The client must authenticate with the network before it can access the requested resource. - * - * Used in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication. - * - * The client needs to authenticate with the network. The client should follow the authentication process provided by the network. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "511"?: Response; - - //#endregion - - /** default — The default response for all codes not covered individually. */ - default?: Response; + //#region Family Codes + + /** 1xx — Informational + * + * Indicates that the request was received and the server is continuing to process it. + * + * Used for provisional responses that indicate the server has received the request and is continuing to process it. These responses are typically used for status updates during long-running operations or to indicate that the server is ready to receive additional data. + * + * The client should continue waiting for the final response. These are provisional responses and the client should not consider the request complete until receiving a final status code. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "1xx"?: Response; + + /** 2xx — Success + * + * Indicates that the request was successfully received, understood, and accepted. + * + * Used for successful operations where the request was processed successfully and the response contains the requested data or indicates successful completion of the operation. + * + * The operation completed successfully. The response body typically contains the requested data or confirmation of the successful operation. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "2xx"?: Response; + + /** 3xx — Redirection + * + * Indicates that further action needs to be taken by the client to complete the request. + * + * Used when the client needs to take additional action to complete the request, such as following a redirect, providing authentication, or accessing the resource at a different location. + * + * The client needs to take additional action to complete the request. This may involve following a redirect, providing authentication, or accessing the resource at a different location. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "3xx"?: Response; + + /** 4xx — Client Error + * + * Indicates that the request contains bad syntax or cannot be fulfilled by the server. + * + * Used when the client has sent an invalid request, such as malformed syntax, invalid parameters, authentication failures, or requests for non-existent resources. + * + * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "4xx"?: Response; + + /** 5xx — Server Error + * + * Indicates that the server failed to fulfill a valid request. + * + * Used when the server encounters an error while processing a valid request, such as internal server errors, service unavailability, or gateway timeouts. + * + * The server encountered an error while processing the request. The client should retry the request later, as this is typically a temporary issue. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "5xx"?: Response; + + //#endregion + + //#region 1xx — Informational + + /** 100 Continue + * + * Indicates that the initial part of the request has been received and the client should continue with the request. + * + * The server has received the request headers and the client should proceed to send the request body. + * + * Used in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns. + * + * The server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue | RFC 9110 §15.2.1} + */ + "100"?: Response; + + /** 101 Switching Protocols + * + * Indicates that the server is switching protocols as requested by the client. + * + * The server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols. + * + * Primarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios. + * + * The connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols | RFC 9110 §15.2.2} + */ + "101"?: Response; + + /** 102 Processing + * + * Indicates that the server has received and is processing the request, but no response is available yet. + * + * The server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting. + * + * Primarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods. + * + * The request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2518 | RFC 2518 (WebDAV)} + */ + "102"?: Response; + + /** 103 Early Hints + * + * Provides early hints about the response that will be sent, allowing the client to start processing before the full response is ready. + * + * The server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early. + * + * Used for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance. + * + * The client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc8297 | RFC 8297} + */ + "103"?: Response; + + /** 104 Upload Resumption Supported — TEMPORARY + * + * Indicates that the server supports resumable uploads for the requested resource. + * + * The server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off. + * + * Used in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste. + * + * The client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions. + * + * @note Temporary registration; see IANA entry for current status/expiry. + * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05 | draft-ietf-httpbis-resumable-upload-05} + * @see {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | IANA registry} + */ + "104"?: Response; + + //#endregion + + //#region 2xx — Success + + /** 200 OK + * + * Indicates that the request has succeeded and the response contains the requested data. + * + * The request was processed successfully and the response body contains the requested resource or data. + * + * The most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return. + * + * The operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok | RFC 9110 §15.3.1} + */ + "200"?: Response; + + /** 201 Created + * + * Indicates that the request has succeeded and a new resource has been created as a result. + * + * The request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource. + * + * Used for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations. + * + * A new resource was successfully created and the response contains information about the created resource, typically including its ID and location. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created | RFC 9110 §15.3.2} + */ + "201"?: Response; + + /** 202 Accepted + * + * Indicates that the request has been accepted for processing, but the processing has not been completed. + * + * The request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed. + * + * Used for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone. + * + * The request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted | RFC 9110 §15.3.3} + */ + "202"?: Response; + + /** 203 Non-Authoritative Information + * + * Indicates that the request was successful, but the information returned is from a transformed or cached version of the original resource. + * + * The response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version. + * + * Used when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware. + * + * The request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-informat | RFC 9110 §15.3.4} + */ + "203"?: Response; + + /** 204 No Content + * + * Indicates that the request has succeeded but there is no content to return in the response body. + * + * The request was processed successfully but the response body is intentionally empty. The client should not expect any content. + * + * Used for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data. + * + * The operation completed successfully but no data is returned. The client should not attempt to parse a response body. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content | RFC 9110 §15.3.5} + */ + "204"?: Response; + + /** 205 Reset Content + * + * Indicates that the request has succeeded and the client should reset the document view that caused the request to be sent. + * + * The request was processed successfully and the client should clear any form data or reset the user interface state. + * + * Used in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations. + * + * The operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content | RFC 9110 §15.3.6} + */ + "205"?: Response; + + /** 206 Partial Content + * + * Indicates that the server is delivering only part of the resource due to a range request. + * + * The request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered. + * + * Used for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads. + * + * The response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content | RFC 9110 §15.3.7} + */ + "206"?: Response; + + /** 207 Multi-Status + * + * Indicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body. + * + * The response contains multiple status codes for different operations, typically in XML format with individual operation results. + * + * Used in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms. + * + * Multiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "207"?: Response; + + /** 208 Already Reported + * + * Indicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again. + * + * Used in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported. + * + * Used in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations. + * + * The information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} + */ + "208"?: Response; + + /** 226 IM Used + * + * Indicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. + * + * The response represents the result of applying instance manipulations (like delta encoding) to the current resource instance. + * + * Used in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission. + * + * The response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc3229 | RFC 3229} + */ + "226"?: Response; + + //#endregion + + //#region 3xx — Redirection + + /** 300 Multiple Choices + * + * Indicates that the request has multiple possible responses and the client should choose one. + * + * The server has multiple representations of the requested resource and the client must choose which one to use. + * + * Used when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics. + * + * The client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices | RFC 9110 §15.4.1} + */ + "300"?: Response; + + /** 301 Moved Permanently + * + * Indicates that the requested resource has been permanently moved to a new location. + * + * The resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header. + * + * Used when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches. + * + * The resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently | RFC 9110 §15.4.2} + */ + "301"?: Response; + + /** 302 Found + * + * Indicates that the requested resource has been temporarily moved to a different location. + * + * The resource is temporarily available at a different URL, but the original URL should continue to be used for future requests. + * + * Used for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid. + * + * The resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found | RFC 9110 §15.4.3} + */ + "302"?: Response; + + /** 303 See Other + * + * Indicates that the response to the request can be found at a different URL and should be retrieved using a GET request. + * + * The request was processed but the response is available at a different location, and the client should use GET to retrieve it. + * + * Used in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions. + * + * The client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other | RFC 9110 §15.4.4} + */ + "303"?: Response; + + /** 304 Not Modified + * + * Indicates that the resource has not been modified since the last request, so the cached version can be used. + * + * The resource has not changed since the last request, and the client can use its cached version. No response body is included. + * + * Used for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer. + * + * The resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified | RFC 9110 §15.4.5} + */ + "304"?: Response; + + /** 305 Use Proxy + * + * Indicates that the requested resource must be accessed through the proxy specified in the Location header. + * + * The client must use the specified proxy to access the resource. This response is rarely used in modern web applications. + * + * Used in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development. + * + * The client should use the specified proxy to access the resource. This is rarely encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy | RFC 9110 §15.4.6} + */ + "305"?: Response; + + /** 306 (Unused) + * + * This status code is reserved and not used in current HTTP specifications. + * + * This status code was previously used but is now reserved and should not be used in new implementations. + * + * Not used in modern web applications. This code is reserved and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-306-unused | RFC 9110 §15.4.7} + */ + "306"?: Response; + + /** 307 Temporary Redirect + * + * Indicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved. + * + * The resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location. + * + * Used for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated. + * + * The resource is temporarily at a different location and the client should repeat the same request method to the new URL. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect | RFC 9110 §15.4.8} + */ + "307"?: Response; + + /** 308 Permanent Redirect + * + * Indicates that the requested resource has been permanently moved to a different location, and the request method should be preserved. + * + * The resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method. + * + * Used for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations. + * + * The resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect | RFC 9110 §15.4.9} + */ + "308"?: Response; + + //#endregion + + //#region 4xx — Client Error + + /** 400 Bad Request + * + * Indicates that the server cannot process the request due to a client error. + * + * The request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process. + * + * Used for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios. + * + * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request | RFC 9110 §15.5.1} + */ + "400"?: Response; + + /** 401 Unauthorized + * + * Indicates that the request requires authentication and the client has not provided valid credentials. + * + * The request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient. + * + * Used when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows. + * + * The client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized | RFC 9110 §15.5.2} + */ + "401"?: Response; + + /** 402 Payment Required + * + * Indicates that the request requires payment before it can be processed. + * + * The request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems. + * + * Used in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services. + * + * The client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required | RFC 9110 §15.5.3} + */ + "402"?: Response; + + /** 403 Forbidden + * + * Indicates that the server understood the request but refuses to authorize it. + * + * The client is authenticated but does not have permission to access the requested resource or perform the requested action. + * + * Used when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios. + * + * The client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden | RFC 9110 §15.5.4} + */ + "403"?: Response; + + /** 404 Not Found + * + * Indicates that the requested resource could not be found on the server. + * + * The server cannot find the requested resource at the specified URL, or the resource does not exist. + * + * Used when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints. + * + * The requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found | RFC 9110 §15.5.5} + */ + "404"?: Response; + + /** 405 Method Not Allowed + * + * Indicates that the HTTP method used in the request is not allowed for the requested resource. + * + * The resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource. + * + * Used when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design. + * + * The HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed | RFC 9110 §15.5.6} + */ + "405"?: Response; + + /** 406 Not Acceptable + * + * Indicates that the server cannot produce a response matching the client's Accept headers. + * + * The server cannot generate a response in any of the formats requested by the client's Accept headers. + * + * Used when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches. + * + * The server cannot provide the requested content type. The client should check the Accept headers or request a different format. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable | RFC 9110 §15.5.7} + */ + "406"?: Response; + + /** 407 Proxy Authentication Required + * + * Indicates that the client must authenticate with the proxy server before the request can be processed. + * + * The proxy server requires authentication before it will forward the request to the destination server. + * + * Used in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies. + * + * The client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-req | RFC 9110 §15.5.8} + */ + "407"?: Response; + + /** 408 Request Timeout + * + * Indicates that the server timed out while waiting for the request from the client. + * + * The server did not receive a complete request within the time it was prepared to wait. + * + * Used when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests. + * + * The request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout | RFC 9110 §15.5.9} + */ + "408"?: Response; + + /** 409 Conflict + * + * Indicates that the request conflicts with the current state of the resource. + * + * The request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification. + * + * Used when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios. + * + * The request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | RFC 9110 §15.5.10} + */ + "409"?: Response; + + /** 410 Gone + * + * Indicates that the requested resource is no longer available and will not be available again. + * + * The resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found. + * + * Used when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios. + * + * The resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone | RFC 9110 §15.5.11} + */ + "410"?: Response; + + /** 411 Length Required + * + * Indicates that the server requires a Content-Length header in the request. + * + * The server cannot process the request without knowing the exact length of the request body. + * + * Used when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints. + * + * The client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required | RFC 9110 §15.5.12} + */ + "411"?: Response; + + /** 412 Precondition Failed + * + * Indicates that one or more preconditions in the request headers were not met. + * + * The server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since. + * + * Used in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios. + * + * The preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed | RFC 9110 §15.5.13} + */ + "412"?: Response; + + /** 413 Content Too Large + * + * Indicates that the request payload is too large for the server to process. + * + * The request body exceeds the server's maximum allowed size limit. + * + * Used when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting. + * + * The request payload is too large. The client should reduce the size of the request body or split it into smaller chunks. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large | RFC 9110 §15.5.14} + */ + "413"?: Response; + + /** 414 URI Too Long + * + * Indicates that the URI provided in the request is too long for the server to process. + * + * The URL exceeds the server's maximum allowed length limit. + * + * Used when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests. + * + * The URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long | RFC 9110 §15.5.15} + */ + "414"?: Response; + + /** 415 Unsupported Media Type + * + * Indicates that the server cannot process the request because the media type is not supported. + * + * The server cannot process the request body because the Content-Type is not supported or recognized. + * + * Used when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements. + * + * The content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type | RFC 9110 §15.5.16} + */ + "415"?: Response; + + /** 416 Range Not Satisfiable + * + * Indicates that the server cannot satisfy the range request specified in the Range header. + * + * The requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests. + * + * Used when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming. + * + * The range request is not satisfiable. The client should check the range specification or request the full resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable | RFC 9110 §15.5.17} + */ + "416"?: Response; + + /** 417 Expectation Failed + * + * Indicates that the server cannot meet the requirements of the Expect header. + * + * The server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation. + * + * Used when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations. + * + * The server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed | RFC 9110 §15.5.18} + */ + "417"?: Response; + + /** 418 (Unused) + * + * This status code is reserved and not used in current HTTP specifications. + * + * This status code is reserved and should not be used in new implementations. + * + * Not used in modern web applications. This code is reserved and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-418-unused | RFC 9110 §15.5.19} + */ + "418"?: Response; + + /** 421 Misdirected Request + * + * Indicates that the request was directed to a server that is not able to produce a response. + * + * The request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems. + * + * Used in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios. + * + * The request was sent to the wrong server. The client should retry the request, which may be routed to a different server. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request | RFC 9110 §15.5.20} + */ + "421"?: Response; + + /** 422 Unprocessable Content + * + * Indicates that the request is well-formed but contains semantic errors that prevent processing. + * + * The request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations. + * + * Used for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid. + * + * The request is well-formed but contains semantic errors. The client should fix the data and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content | RFC 9110 §15.5.21} + */ + "422"?: Response; + + /** 423 Locked + * + * Indicates that the requested resource is locked and cannot be modified. + * + * The resource is locked by another process or user and cannot be accessed or modified at this time. + * + * Used in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms. + * + * The resource is locked and cannot be accessed. The client should wait and retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "423"?: Response; + + /** 424 Failed Dependency + * + * Indicates that the request failed because it depended on another request that also failed. + * + * The request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations. + * + * Used in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios. + * + * The request failed due to a dependency failure. The client should check the dependencies and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "424"?: Response; + + /** 425 Too Early + * + * Indicates that the server is unwilling to process the request because it might be replayed. + * + * The server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns. + * + * Used in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols. + * + * The server is unwilling to process the request due to replay concerns. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc8470 | RFC 8470} + */ + "425"?: Response; + + /** 426 Upgrade Required + * + * Indicates that the server requires the client to upgrade to a different protocol. + * + * The server requires the client to use a different protocol version or upgrade to a newer version to access the resource. + * + * Used when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios. + * + * The client must upgrade to a different protocol version. The response should include upgrade information. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required | RFC 9110 §15.5.22} + */ + "426"?: Response; + + /** 428 Precondition Required + * + * Indicates that the server requires the request to include certain preconditions. + * + * The server requires the client to include specific preconditions in the request headers before it will process the request. + * + * Used when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios. + * + * The server requires specific preconditions. The client should include the required preconditions and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "428"?: Response; + + /** 429 Too Many Requests + * + * Indicates that the client has sent too many requests in a given time period and should slow down. + * + * The client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets. + * + * Used for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers. + * + * The client has exceeded the rate limit and should slow down. The client should wait before retrying the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "429"?: Response; + + /** 431 Request Header Fields Too Large + * + * Indicates that the server is unwilling to process the request because the header fields are too large. + * + * The request headers exceed the server's maximum allowed size limit. + * + * Used when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data. + * + * The request headers are too large. The client should reduce the size of the headers and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "431"?: Response; + + /** 451 Unavailable For Legal Reasons + * + * Indicates that the requested resource is unavailable due to legal reasons. + * + * The resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements. + * + * Used when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services. + * + * The resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc7725 | RFC 7725} + */ + "451"?: Response; + + //#endregion + + //#region 5xx — Server Error + + /** 500 Internal Server Error + * + * Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. + * + * The server encountered an internal error or exception that prevented it from processing the request successfully. + * + * Used for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems. + * + * The server encountered an internal error. The client should retry the request later, as this is typically a temporary issue. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error | RFC 9110 §15.6.1} + */ + "500"?: Response; + + /** 501 Not Implemented + * + * Indicates that the server does not support the functionality required to fulfill the request. + * + * The server does not recognize the request method or lacks the ability to fulfill the request. + * + * Used when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented. + * + * The server does not support the requested functionality. The client should check the API documentation for supported methods and features. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented | RFC 9110 §15.6.2} + */ + "501"?: Response; + + /** 502 Bad Gateway + * + * Indicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server. + * + * The server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access. + * + * Used in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems. + * + * The gateway received an invalid response from the upstream server. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway | RFC 9110 §15.6.3} + */ + "502"?: Response; + + /** 503 Service Unavailable + * + * Indicates that the server is temporarily unable to handle the request due to maintenance or overload. + * + * The server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints. + * + * Used during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows. + * + * The server is temporarily unavailable. The client should retry the request later, often with exponential backoff. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable | RFC 9110 §15.6.4} + */ + "503"?: Response; + + /** 504 Gateway Timeout + * + * Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server. + * + * The gateway or proxy server timed out while waiting for a response from the upstream server. + * + * Used in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times. + * + * The gateway timed out waiting for the upstream server. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout | RFC 9110 §15.6.5} + */ + "504"?: Response; + + /** 505 HTTP Version Not Supported + * + * Indicates that the server does not support the HTTP protocol version used in the request. + * + * The server does not support the HTTP protocol version specified in the request. + * + * Used when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios. + * + * The server does not support the HTTP version used in the request. The client should use a supported HTTP version. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-supporte | RFC 9110 §15.6.6} + */ + "505"?: Response; + + /** 506 Variant Also Negotiates + * + * Indicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation. + * + * The server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop. + * + * Used in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations. + * + * The server has a configuration error in content negotiation. The client should contact the server administrator. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2295 | RFC 2295} + */ + "506"?: Response; + + /** 507 Insufficient Storage + * + * Indicates that the server is unable to store the representation needed to complete the request. + * + * The server cannot store the representation required to complete the request, typically due to storage space limitations. + * + * Used in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms. + * + * The server cannot store the required representation. The client should check storage availability and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "507"?: Response; + + /** 508 Loop Detected + * + * Indicates that the server detected an infinite loop while processing the request. + * + * The server detected an infinite loop in the request processing, typically in WebDAV operations. + * + * Used in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios. + * + * The server detected an infinite loop. The client should check the request for circular references and retry. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} + */ + "508"?: Response; + + /** 510 Not Extended — OBSOLETED + * + * This status code is obsolete and should not be used in modern implementations. + * + * This status code was used for HTTP extensions but is now obsolete and should not be used. + * + * Not used in modern web applications. This code is obsolete and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2774 | RFC 2774 (Historic)} + * @see {@link https://datatracker.ietf.org/doc/status-change-http-experiments-to-historic/ | IETF: Status change of HTTP experiments to Historic} + */ + "510"?: Response; + + /** 511 Network Authentication Required + * + * Indicates that the client needs to authenticate to gain network access. + * + * The client must authenticate with the network before it can access the requested resource. + * + * Used in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication. + * + * The client needs to authenticate with the network. The client should follow the authentication process provided by the network. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "511"?: Response; + + //#endregion + + /** default — The default response for all codes not covered individually. */ + default?: Response; } diff --git a/3.0/tags.ts b/3.0/tags.ts index 18bef16..5e5a2e8 100644 --- a/3.0/tags.ts +++ b/3.0/tags.ts @@ -58,54 +58,54 @@ import type { ExternalDocumentation } from "./externalDocs"; * ``` */ export interface Tag extends Extension { - /** - * The name of the tag. This field is required. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object | OpenAPI 3.0.4 Tag Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object | OpenAPI 3.0.3 Tag Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object | OpenAPI 3.0.2 Tag Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object | OpenAPI 3.0.1 Tag Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object | OpenAPI 3.0.0 Tag Object - name} | - * @property `name` - Required The name of the tag - * - * @example "users" - * @example "pets" - * @example "authentication" - */ - name: string; + /** + * The name of the tag. This field is required. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object | OpenAPI 3.0.4 Tag Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object | OpenAPI 3.0.3 Tag Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object | OpenAPI 3.0.2 Tag Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object | OpenAPI 3.0.1 Tag Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object | OpenAPI 3.0.0 Tag Object - name} | + * @property `name` - Required The name of the tag + * + * @example "users" + * @example "pets" + * @example "authentication" + */ + name: string; - /** - * A short description for the tag. CommonMark syntax MAY be used for rich text representation. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object | OpenAPI 3.0.4 Tag Object - description} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object | OpenAPI 3.0.3 Tag Object - description} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object | OpenAPI 3.0.2 Tag Object - description} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object | OpenAPI 3.0.1 Tag Object - description} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object | OpenAPI 3.0.0 Tag Object - description} | - * @property `description` - Optional A short description for the tag - * - * @example "User management operations" - * @example "Pet store operations" - */ - description?: string; + /** + * A short description for the tag. CommonMark syntax MAY be used for rich text representation. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object | OpenAPI 3.0.4 Tag Object - description} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object | OpenAPI 3.0.3 Tag Object - description} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object | OpenAPI 3.0.2 Tag Object - description} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object | OpenAPI 3.0.1 Tag Object - description} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object | OpenAPI 3.0.0 Tag Object - description} | + * @property `description` - Optional A short description for the tag + * + * @example "User management operations" + * @example "Pet store operations" + */ + description?: string; - /** - * Additional external documentation for this tag. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object | OpenAPI 3.0.4 Tag Object - externalDocs} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object | OpenAPI 3.0.3 Tag Object - externalDocs} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object | OpenAPI 3.0.2 Tag Object - externalDocs} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object | OpenAPI 3.0.1 Tag Object - externalDocs} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object | OpenAPI 3.0.0 Tag Object - externalDocs} | - * @property `externalDocs` - Optional Additional external documentation for this tag - * - * @example { description: "Find out more about user management", url: "https://example.com/docs/users" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for this tag. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object | OpenAPI 3.0.4 Tag Object - externalDocs} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object | OpenAPI 3.0.3 Tag Object - externalDocs} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object | OpenAPI 3.0.2 Tag Object - externalDocs} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object | OpenAPI 3.0.1 Tag Object - externalDocs} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object | OpenAPI 3.0.0 Tag Object - externalDocs} | + * @property `externalDocs` - Optional Additional external documentation for this tag + * + * @example { description: "Find out more about user management", url: "https://example.com/docs/users" } + */ + externalDocs?: ExternalDocumentation; } diff --git a/3.0/xml.ts b/3.0/xml.ts index 40d91c2..de34c79 100644 --- a/3.0/xml.ts +++ b/3.0/xml.ts @@ -76,94 +76,94 @@ import type { Extension } from "./extensions"; * ``` */ export interface XML extends Extension { - /** - * Replaces the name of the element/attribute used for the described schema property. - * When defined within items, it will affect the name of the individual XML elements within the list. - * When defined alongside type being array (outside the items), it will affect the wrapping element - * and only if wrapped is true. If wrapped is false, it will affect the items within the array. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - name} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - name} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - name} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - name} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - name} | - * @property `name` - Optional Replaces the name of the element/attribute used for the described schema property - * - * @example "animal" - * @example "item" - */ - name?: string; + /** + * Replaces the name of the element/attribute used for the described schema property. + * When defined within items, it will affect the name of the individual XML elements within the list. + * When defined alongside type being array (outside the items), it will affect the wrapping element + * and only if wrapped is true. If wrapped is false, it will affect the items within the array. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - name} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - name} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - name} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - name} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - name} | + * @property `name` - Optional Replaces the name of the element/attribute used for the described schema property + * + * @example "animal" + * @example "item" + */ + name?: string; - /** - * The URL of the namespace definition. Value SHOULD be in the form of a URL. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - namespace} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - namespace} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - namespace} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - namespace} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - namespace} | - * @property `namespace` - Optional The URL of the namespace definition - * - * @example "http://example.com/schema" - * @example "http://www.w3.org/XML/1998/namespace" - */ - namespace?: string; + /** + * The URL of the namespace definition. Value SHOULD be in the form of a URL. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - namespace} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - namespace} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - namespace} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - namespace} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - namespace} | + * @property `namespace` - Optional The URL of the namespace definition + * + * @example "http://example.com/schema" + * @example "http://www.w3.org/XML/1998/namespace" + */ + namespace?: string; - /** - * The prefix to be used for the name. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - prefix} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - prefix} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - prefix} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - prefix} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - prefix} | - * @property `prefix` - Optional The prefix to be used for the name - * - * @example "xs" - * @example "ns" - */ - prefix?: string; + /** + * The prefix to be used for the name. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - prefix} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - prefix} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - prefix} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - prefix} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - prefix} | + * @property `prefix` - Optional The prefix to be used for the name + * + * @example "xs" + * @example "ns" + */ + prefix?: string; - /** - * Declares whether the property definition translates to an attribute instead of an element. - * Default value is false. - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - attribute} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - attribute} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - attribute} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - attribute} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - attribute} | - * @property `attribute` - Optional Declares whether the property definition translates to an attribute instead of an element - * - * @example true - * @example false - */ - attribute?: boolean; + /** + * Declares whether the property definition translates to an attribute instead of an element. + * Default value is false. + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - attribute} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - attribute} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - attribute} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - attribute} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - attribute} | + * @property `attribute` - Optional Declares whether the property definition translates to an attribute instead of an element + * + * @example true + * @example false + */ + attribute?: boolean; - /** - * MAY be used only for an array definition. Signifies whether the array is wrapped (for example, - * ) or unwrapped (). Default value is false. - * The definition takes effect only when defined alongside type being array (outside the items). - * * - * | Version | Reference | - * |---|-----| - * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - wrapped} | - * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - wrapped} | - * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - wrapped} | - * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - wrapped} | - * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - wrapped} | - * @property `wrapped` - Optional MAY be used only for an array definition. Signifies whether the array is wrapped - * - * @example true - * @example false - */ - wrapped?: boolean; + /** + * MAY be used only for an array definition. Signifies whether the array is wrapped (for example, + * ) or unwrapped (). Default value is false. + * The definition takes effect only when defined alongside type being array (outside the items). + * * + * | Version | Reference | + * |---|-----| + * | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object | OpenAPI 3.0.4 XML Object - wrapped} | + * | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object | OpenAPI 3.0.3 XML Object - wrapped} | + * | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object | OpenAPI 3.0.2 XML Object - wrapped} | + * | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object | OpenAPI 3.0.1 XML Object - wrapped} | + * | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object | OpenAPI 3.0.0 XML Object - wrapped} | + * @property `wrapped` - Optional MAY be used only for an array definition. Signifies whether the array is wrapped + * + * @example true + * @example false + */ + wrapped?: boolean; } diff --git a/3.1/3.1.0.md b/3.1/3.1.0.md index 1f08306..96f253d 100644 --- a/3.1/3.1.0.md +++ b/3.1/3.1.0.md @@ -13,65 +13,67 @@ The OpenAPI Specification (OAS) defines a standard, language-agnostic interface An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases. ## Table of Contents + - [Definitions](#definitions) - - [OpenAPI Document](#openapi-document) - - [Path Templating](#path-templating) - - [Media Types](#media-types) - - [HTTP Status Codes](#http-status-codes) + - [OpenAPI Document](#openapi-document) + - [Path Templating](#path-templating) + - [Media Types](#media-types) + - [HTTP Status Codes](#http-status-codes) - [Specification](#specification) - - [Versions](#versions) - - [Format](#format) - - [Document Structure](#document-structure) - - [Data Types](#data-types) - - [Rich Text Formatting](#rich-text-formatting) - - [Relative References In URIs](#relative-references-in-uris) - - [Relative References In URLs](#relative-references-in-urls) - - [Schema](#schema) - - [OpenAPI Object](#openapi-object) - - [Info Object](#info-object) - - [Contact Object](#contact-object) - - [License Object](#license-object) - - [Server Object](#server-object) - - [Server Variable Object](#server-variable-object) - - [Components Object](#components-object) - - [Paths Object](#paths-object) - - [Path Item Object](#path-item-object) - - [Operation Object](#operation-object) - - [External Documentation Object](#external-documentation-object) - - [Parameter Object](#parameter-object) - - [Request Body Object](#request-body-object) - - [Media Type Object](#media-type-object) - - [Encoding Object](#encoding-object) - - [Responses Object](#responses-object) - - [Response Object](#response-object) - - [Callback Object](#callback-object) - - [Example Object](#example-object) - - [Link Object](#link-object) - - [Header Object](#header-object) - - [Tag Object](#tag-object) - - [Reference Object](#reference-object) - - [Schema Object](#schema-object) - - [Discriminator Object](#discriminator-object) - - [XML Object](#xml-object) - - [Security Scheme Object](#security-scheme-object) - - [OAuth Flows Object](#oauth-flows-object) - - [OAuth Flow Object](#oauth-flow-object) - - [Security Requirement Object](#security-requirement-object) - - [Specification Extensions](#specification-extensions) - - [Security Filtering](#security-filtering) + - [Versions](#versions) + - [Format](#format) + - [Document Structure](#document-structure) + - [Data Types](#data-types) + - [Rich Text Formatting](#rich-text-formatting) + - [Relative References In URIs](#relative-references-in-uris) + - [Relative References In URLs](#relative-references-in-urls) + - [Schema](#schema) + - [OpenAPI Object](#openapi-object) + - [Info Object](#info-object) + - [Contact Object](#contact-object) + - [License Object](#license-object) + - [Server Object](#server-object) + - [Server Variable Object](#server-variable-object) + - [Components Object](#components-object) + - [Paths Object](#paths-object) + - [Path Item Object](#path-item-object) + - [Operation Object](#operation-object) + - [External Documentation Object](#external-documentation-object) + - [Parameter Object](#parameter-object) + - [Request Body Object](#request-body-object) + - [Media Type Object](#media-type-object) + - [Encoding Object](#encoding-object) + - [Responses Object](#responses-object) + - [Response Object](#response-object) + - [Callback Object](#callback-object) + - [Example Object](#example-object) + - [Link Object](#link-object) + - [Header Object](#header-object) + - [Tag Object](#tag-object) + - [Reference Object](#reference-object) + - [Schema Object](#schema-object) + - [Discriminator Object](#discriminator-object) + - [XML Object](#xml-object) + - [Security Scheme Object](#security-scheme-object) + - [OAuth Flows Object](#oauth-flows-object) + - [OAuth Flow Object](#oauth-flow-object) + - [Security Requirement Object](#security-requirement-object) + - [Specification Extensions](#specification-extensions) + - [Security Filtering](#security-filtering) - [Appendix A: Revision History](#appendix-a-revision-history) - ## Definitions ##### OpenAPI Document + A self-contained or composite resource which defines or describes an API or elements of an API. The OpenAPI document MUST contain at least one [paths](#paths-object) field, a [components](#oasComponents) field or a [webhooks](#oasWebhooks) field. An OpenAPI document uses and conforms to the OpenAPI Specification. ##### Path Templating + Path templating refers to the usage of template expressions, delimited by curly braces ({}), to mark a section of a URL path as replaceable using path parameters. Each template expression in the path MUST correspond to a path parameter that is included in the [Path Item](#path-item-object) itself and/or in each of the Path Item's [Operations](#operation-object). An exception is if the path item is empty, for example due to ACL constraints, matching path parameters are not required. @@ -79,10 +81,12 @@ Each template expression in the path MUST correspond to a path parameter that is The value for these path parameters MUST NOT contain any unescaped "generic syntax" characters described by [RFC3986](https://tools.ietf.org/html/rfc3986#section-3): forward slashes (`/`), question marks (`?`), or hashes (`#`). ##### Media Types + Media type definitions are spread across several resources. The media type definitions SHOULD be in compliance with [RFC6838](https://tools.ietf.org/html/rfc6838). Some examples of possible media type definitions: + ``` text/plain; charset=utf-8 application/json @@ -95,7 +99,9 @@ Some examples of possible media type definitions: application/vnd.github.v3.diff application/vnd.github.v3.patch ``` + ##### HTTP Status Codes + The HTTP Status Codes are used to indicate the status of the executed operation. The available status codes are defined by [RFC7231](https://tools.ietf.org/html/rfc7231#section-6) and registered status codes are listed in the [IANA Status Code Registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml). @@ -103,7 +109,7 @@ The available status codes are defined by [RFC7231](https://tools.ietf.org/html/ ### Versions -The OpenAPI Specification is versioned using a `major`.`minor`.`patch` versioning scheme. The `major`.`minor` portion of the version string (for example `3.1`) SHALL designate the OAS feature set. *`.patch`* versions address errors in, or provide clarifications to, this document, not the feature set. Tooling which supports OAS 3.1 SHOULD be compatible with all OAS 3.1.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.1.0` and `3.1.1` for example. +The OpenAPI Specification is versioned using a `major`.`minor`.`patch` versioning scheme. The `major`.`minor` portion of the version string (for example `3.1`) SHALL designate the OAS feature set. _`.patch`_ versions address errors in, or provide clarifications to, this document, not the feature set. Tooling which supports OAS 3.1 SHOULD be compatible with all OAS 3.1.\* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between `3.1.0` and `3.1.1` for example. Occasionally, non-backwards compatible changes may be made in `minor` versions of the OAS where impact is believed to be low relative to the benefit provided. @@ -117,9 +123,10 @@ For example, if a field has an array value, the JSON array representation will b ```json { - "field": [ 1, 2, 3 ] + "field": [1, 2, 3] } ``` + All field names in the specification are **case sensitive**. This includes all fields that are used as keys in a map, except where explicitly noted that keys are **case insensitive**. @@ -151,15 +158,16 @@ OAS defines additional formats to provide fine detail for primitive data types. The formats defined by the OAS are: -[`type`](#data-types) | [`format`](#dataTypeFormat) | Comments ------- | -------- | -------- -`integer` | `int32` | signed 32 bits -`integer` | `int64` | signed 64 bits (a.k.a long) -`number` | `float` | | -`number` | `double` | | -`string` | `password` | A hint to UIs to obscure input. +| [`type`](#data-types) | [`format`](#dataTypeFormat) | Comments | +| --------------------- | --------------------------- | ------------------------------- | +| `integer` | `int32` | signed 32 bits | +| `integer` | `int64` | signed 64 bits (a.k.a long) | +| `number` | `float` | | +| `number` | `double` | | +| `string` | `password` | A hint to UIs to obscure input. | ### Rich Text Formatting + Throughout the specification `description` fields are noted as supporting CommonMark markdown formatting. Where OpenAPI tooling renders rich text it MUST support, at a minimum, markdown syntax as described by [CommonMark 0.27](https://spec.commonmark.org/0.27/). Tooling MAY choose to ignore some CommonMark features to address security concerns. @@ -169,9 +177,9 @@ Unless specified otherwise, all properties that are URIs MAY be relative referen Relative references, including those in [`Reference Objects`](#reference-object), [`PathItem Object`](#path-item-object) `$ref` fields, [`Link Object`](#link-object) `operationRef` fields and [`Example Object`](#example-object) `externalValue` fields, are resolved using the referring document as the Base URI according to [RFC3986](https://tools.ietf.org/html/rfc3986#section-5.2). -If a URI contains a fragment identifier, then the fragment should be resolved per the fragment resolution mechanism of the referenced document. If the representation of the referenced document is JSON or YAML, then the fragment identifier SHOULD be interpreted as a JSON-Pointer as per [RFC6901](https://tools.ietf.org/html/rfc6901). +If a URI contains a fragment identifier, then the fragment should be resolved per the fragment resolution mechanism of the referenced document. If the representation of the referenced document is JSON or YAML, then the fragment identifier SHOULD be interpreted as a JSON-Pointer as per [RFC6901](https://tools.ietf.org/html/rfc6901). -Relative references in [`Schema Objects`](#schema-object), including any that appear as `$id` values, use the nearest parent `$id` as a Base URI, as described by [JSON Schema Specification Draft 2020-12](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-8.2). If no parent schema contains an `$id`, then the Base URI MUST be determined according to [RFC3986](https://tools.ietf.org/html/rfc3986#section-5.1). +Relative references in [`Schema Objects`](#schema-object), including any that appear as `$id` values, use the nearest parent `$id` as a Base URI, as described by [JSON Schema Specification Draft 2020-12](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-8.2). If no parent schema contains an `$id`, then the Base URI MUST be determined according to [RFC3986](https://tools.ietf.org/html/rfc3986#section-5.1). ### Relative References in URLs @@ -188,19 +196,18 @@ This is the root object of the [OpenAPI document](#openapi-document). ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is *not* related to the API [`info.version`](#infoVersion) string. -info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. - jsonSchemaDialect | `string` | The default value for the `$schema` keyword within [Schema Objects](#schema-object) contained within this OAS document. This MUST be in the form of a URI. -servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. -paths | [Paths Object](#paths-object) | The available paths and operations for the API. -webhooks | Map[`string`, [Path Item Object](#path-item-object) \| [Reference Object](#reference-object)] ] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](../examples/v3.1/webhook-example.yaml) is available. -components | [Components Object](#components-object) | An element to hold various schemas for the document. -security | [[Security Requirement Object](#security-requirement-object)] | 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. -tags | [[Tag Object](#tag-object)] | A list of tags used by the document 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](#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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. - +| Field Name | Type | Description | +| ----------------------------------------------------- | :---------------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the API [`info.version`](#infoVersion) string. | +| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| jsonSchemaDialect | `string` | The default value for the `$schema` keyword within [Schema Objects](#schema-object) contained within this OAS document. This MUST be in the form of a URI. | +| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` property is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#serverUrl) value of `/`. | +| paths | [Paths Object](#paths-object) | The available paths and operations for the API. | +| webhooks | Map[`string`, [Path Item Object](#path-item-object) \| [Reference Object](#reference-object)] ] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](../examples/v3.1/webhook-example.yaml) is available. | +| components | [Components Object](#components-object) | An element to hold various schemas for the document. | +| security | [[Security Requirement Object](#security-requirement-object)] | 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. | +| tags | [[Tag Object](#tag-object)] | A list of tags used by the document 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -211,16 +218,15 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -title | `string` | **REQUIRED**. The title of the API. -summary | `string` | A short summary of the API. -description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -termsOfService | `string` | A URL to the Terms of Service for the API. This MUST be in the form of a URL. -contact | [Contact Object](#contact-object) | The contact information for the exposed API. -license | [License Object](#license-object) | The license information for the exposed API. -version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). - +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **REQUIRED**. The title of the API. | +| summary | `string` | A short summary of the API. | +| description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | A URL to the Terms of Service for the API. This MUST be in the form of a URL. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oasVersion) or the API implementation version). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -266,11 +272,11 @@ Contact information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | The identifying name of the contact person/organization. -url | `string` | The URL pointing to the contact information. This MUST be in the form of a URL. -email | `string` | The email address of the contact person/organization. This MUST be in the form of an email address. +| Field Name | Type | Description | +| -------------------------------- | :------: | --------------------------------------------------------------------------------------------------- | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URL pointing to the contact information. This MUST be in the form of a URL. | +| email | `string` | The email address of the contact person/organization. This MUST be in the form of an email address. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -296,11 +302,11 @@ License information for the exposed API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The license name used for the API. -identifier | `string` | An [SPDX](https://spdx.org/licenses/) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. -url | `string` | A 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. +| Field Name | Type | Description | +| ------------------------------------------ | :------: | ------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **REQUIRED**. The license name used for the API. | +| identifier | `string` | An [SPDX](https://spdx.org/licenses/) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. | +| url | `string` | A 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -324,11 +330,11 @@ An object representing a Server. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. -description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in `{`brackets`}`. | +| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -371,12 +377,12 @@ The following shows how multiple servers can be described, for example, at the O ```yaml servers: -- url: https://development.gigantic-server.com/v1 - description: Development server -- url: https://staging.gigantic-server.com/v1 - description: Staging server -- url: https://api.gigantic-server.com/v1 - description: Production server + - url: https://development.gigantic-server.com/v1 + description: Development server + - url: https://staging.gigantic-server.com/v1 + description: Staging server + - url: https://api.gigantic-server.com/v1 + description: Production server ``` The following shows how variables can be used for a server configuration: @@ -393,10 +399,7 @@ The following shows how variables can be used for a server configuration: "description": "this value is assigned by the service provider, in this example `gigantic-server.com`" }, "port": { - "enum": [ - "8443", - "443" - ], + "enum": ["8443", "443"], "default": "8443" }, "basePath": { @@ -410,35 +413,34 @@ The following shows how variables can be used for a server configuration: ```yaml servers: -- url: https://{username}.gigantic-server.com:{port}/{basePath} - description: The production API server - variables: - username: - # note! no enum here means it is an open value - default: demo - description: this value is assigned by the service provider, in this example `gigantic-server.com` - port: - enum: - - '8443' - - '443' - default: '8443' - basePath: - # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` - default: v2 + - url: https://{username}.gigantic-server.com:{port}/{basePath} + description: The production API server + variables: + username: + # note! no enum here means it is an open value + default: demo + description: this value is assigned by the service provider, in this example `gigantic-server.com` + port: + enum: + - "8443" + - "443" + default: "8443" + basePath: + # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` + default: v2 ``` - #### Server Variable Object An object representing a Server Variable for server URL template substitution. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. -default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional. If the [`enum`](#serverVariableEnum) is defined, the value MUST exist in the enum's values. -description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. +| Field Name | Type | Description | +| --------------------------------------------------- | :--------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. | +| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. Note this behavior is different than the [Schema Object's](#schema-object) treatment of default values, because in those cases parameter values are optional. If the [`enum`](#serverVariableEnum) is defined, the value MUST exist in the enum's values. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -447,22 +449,20 @@ This object MAY be extended with [Specification Extensions](#specification-exten Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object. - ##### Fixed Fields -Field Name | Type | Description ----|:---|--- - schemas | Map[`string`, [Schema Object](#schema-object)] | An object to hold reusable [Schema Objects](#schema-object). - responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). - parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). - examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). - requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). - headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). - securitySchemes| Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). - links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). - callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). - pathItems | Map[`string`, [Path Item Object](#path-item-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Path Item Object](#path-item-object). - +| Field Name | Type | Description | +| -------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| schemas | Map[`string`, [Schema Object](#schema-object)] | An object to hold reusable [Schema Objects](#schema-object). | +| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | +| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | +| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | +| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | +| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | +| pathItems | Map[`string`, [Path Item Object](#path-item-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Path Item Object](#path-item-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -636,7 +636,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GeneralError' + $ref: "#/components/schemas/GeneralError" securitySchemes: api_key: type: apiKey @@ -655,13 +655,13 @@ components: #### Paths Object Holds the relative paths to the individual endpoints and their operations. -The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [Access Control List (ACL) constraints](#security-filtering). +The path is appended to the URL from the [`Server Object`](#server-object) in order to construct the full URL. The Paths MAY be empty, due to [Access Control List (ACL) constraints](#security-filtering). ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -/{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. +| Field Pattern | Type | Description | +| ------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The path is **appended** (no relative URL resolution) to the expanded URL from the [`Server Object`](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -696,7 +696,7 @@ The following may lead to ambiguous resolution: "get": { "description": "Returns all pets from the system that the user has access to", "responses": { - "200": { + "200": { "description": "A list of pets.", "content": { "application/json": { @@ -720,14 +720,14 @@ The following may lead to ambiguous resolution: get: description: Returns all pets from the system that the user has access to responses: - '200': + "200": description: A list of pets. content: application/json: schema: type: array items: - $ref: '#/components/schemas/pet' + $ref: "#/components/schemas/pet" ``` #### Path Item Object @@ -738,22 +738,21 @@ The path itself is still exposed to the documentation viewer but they will not k ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | Allows for a referenced definition of this path item. The referenced structure MUST be in the form of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving [Relative References](#relative-references-in-uris). -summary| `string` | An optional, string summary, intended to apply to all operations in this path. -description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -get | [Operation Object](#operation-object) | A definition of a GET operation on this path. -put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. -post | [Operation Object](#operation-object) | A definition of a POST operation on this path. -delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. -options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. -head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. -patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. -trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. -servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). - +| Field Name | Type | Description | +| --------------------------------------------- | :------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for a referenced definition of this path item. The referenced structure MUST be in the form of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving [Relative References](#relative-references-in-uris). | +| summary | `string` | An optional, string summary, intended to apply to all operations in this path. | +| description | `string` | An optional, string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | +| servers | [[Server Object](#server-object)] | An alternative `server` array to service all operations in this path. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -815,30 +814,30 @@ get: summary: Find pets by ID operationId: getPetsById responses: - '200': + "200": description: pet response content: - '*/*' : + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: - 'text/html': + "text/html": schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" parameters: -- name: id - in: path - description: ID of pet to use - required: true - schema: - type: array - items: - type: string - style: simple + - name: id + in: path + description: ID of pet to use + required: true + schema: + type: array + items: + type: string + style: simple ``` #### Operation Object @@ -847,20 +846,20 @@ Describes a single API operation on a path. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. -summary | `string` | A short summary of what the operation does. -description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. -operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. -parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). -requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is fully supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as [GET](https://tools.ietf.org/html/rfc7231#section-4.3.1), [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)), `requestBody` is permitted but does not have well-defined semantics and SHOULD be avoided if possible. -responses | [Responses Object](#responses-object) | The list of possible responses as they are returned from executing this operation. -callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. -deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. -security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. -servers | [[Server Object](#server-object)] | 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. +| Field Name | Type | Description | +| ------------------------------------------------ | :-----------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. | +| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#pathItemParameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). The list can use the [Reference Object](#reference-object) to link to parameters that are defined at the [OpenAPI Object's components/parameters](#componentsParameters). | +| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is fully supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as [GET](https://tools.ietf.org/html/rfc7231#section-4.3.1), [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)), `requestBody` is permitted but does not have well-defined semantics and SHOULD be avoided if possible. | +| responses | [Responses Object](#responses-object) | The list of possible responses as they are returned from executing this operation. | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. | +| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oasSecurity). To remove a top-level security declaration, an empty array can be used. | +| servers | [[Server Object](#server-object)] | 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. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -868,9 +867,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "tags": [ - "pet" - ], + "tags": ["pet"], "summary": "Updates a pet in the store with form data", "operationId": "updatePetWithForm", "parameters": [ @@ -922,10 +919,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten }, "security": [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] } @@ -933,58 +927,57 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```yaml tags: -- pet + - pet summary: Updates a pet in the store with form data operationId: updatePetWithForm parameters: -- name: petId - in: path - description: ID of pet that needs to be updated - required: true - schema: - type: string + - name: petId + in: path + description: ID of pet that needs to be updated + required: true + schema: + type: string requestBody: content: - 'application/x-www-form-urlencoded': + "application/x-www-form-urlencoded": schema: - type: object - properties: + type: object + properties: name: description: Updated name of the pet type: string status: description: Updated status of the pet type: string - required: - - status + required: + - status responses: - '200': + "200": description: Pet updated. content: - 'application/json': {} - 'application/xml': {} - '405': + "application/json": {} + "application/xml": {} + "405": description: Method Not Allowed content: - 'application/json': {} - 'application/xml': {} + "application/json": {} + "application/xml": {} security: -- petstore_auth: - - write:pets - - read:pets + - petstore_auth: + - write:pets + - read:pets ``` - #### External Documentation Object Allows referencing an external resource for extended documentation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -url | `string` | **REQUIRED**. The URL for the target documentation. This MUST be in the form of a URL. +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | -------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| url | `string` | **REQUIRED**. The URL for the target documentation. This MUST be in the form of a URL. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1009,58 +1002,58 @@ Describes a single operation parameter. A unique parameter is defined by a combination of a [name](#parameterName) and [location](#parameterIn). ##### Parameter Locations -There are four possible parameter locations specified by the `in` field: -* path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. -* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. -* cookie - Used to pass a specific cookie value to the API. +There are four possible parameter locations specified by the `in` field: + +- path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +- header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. +- cookie - Used to pass a specific cookie value to the API. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the parameter. Parameter names are *case sensitive*.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
-in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. -description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is `"path"`, this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. - deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. - allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. + +| Field Name | Type | Description | +| ------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameterIn) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#pathsPath) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameterIn) 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`](#parameterIn) property.
| +| in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. | +| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameterIn) is `"path"`, this property is **REQUIRED** and its value MUST be `true`. Otherwise, the property MAY be included and its default value is `false`. | +| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| allowEmptyValue | `boolean` | Sets the ability to pass empty-valued parameters. This is valid only for `query` parameters and allows sending a parameter with an empty value. Default value is `false`. If [`style`](#parameterStyle) is used, and if behavior is `n/a` (cannot be serialized), the value of `allowEmptyValue` SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision. | The rules for serialization of the parameter are specified in one of two ways. For simpler scenarios, a [`schema`](#parameterSchema) and [`style`](#parameterStyle) can describe the structure and syntax of the parameter. -Field Name | Type | Description ----|:---:|--- -style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. -explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. -schema | [Schema Object](#schema-object) | The schema defining the type used for the parameter. -example | Any | Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` that contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema. +| Field Name | Type | Description | +| -------------------------------------------------- | :----------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `query` - `form`; for `path` - `simple`; for `header` - `simple`; for `cookie` - `form`. | +| explode | `boolean` | 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`](#parameterStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. This property only applies to parameters with an `in` value of `query`. The default value is `false`. | +| schema | [Schema Object](#schema-object) | The schema defining the type used for the parameter. | +| example | Any | Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties if present. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` that contains an example, the `example` value SHALL _override_ the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` that contains an example, the `examples` value SHALL _override_ the example provided by the schema. | For more complex scenarios, the [`content`](#parameterContent) property can define the media type and schema of the parameter. A parameter MUST contain either a `schema` property, or a `content` property, but not both. When `example` or `examples` are provided in conjunction with the `schema` object, the example MUST follow the prescribed serialization strategy for the parameter. - -Field Name | Type | Description ----|:---:|--- -content | Map[`string`, [Media Type Object](#media-type-object)] | 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. +| Field Name | Type | Description | +| -------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| content | Map[`string`, [Media Type Object](#media-type-object)] | 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. | ##### Style Values In order to support common ways of serializing simple parameters, a set of `style` values are defined. -`style` | [`type`](#data-types) | `in` | Comments ------------ | ------ | -------- | -------- -matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) -label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) -form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. -simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. -spaceDelimited | `array`, `object` | `query` | Space separated array or object values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. -pipeDelimited | `array`, `object` | `query` | Pipe separated array or object values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. -deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. - +| `style` | [`type`](#data-types) | `in` | Comments | +| -------------- | ------------------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| simple | `array` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| spaceDelimited | `array`, `object` | `query` | Space separated array or object values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| pipeDelimited | `array`, `object` | `query` | Pipe separated array or object values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| deepObject | `object` | `query` | Provides a simple way of rendering nested objects using form parameters. | ##### Style Examples @@ -1071,21 +1064,22 @@ Assume a parameter named `color` has one of the following values: array -> ["blue","black","brown"] object -> { "R": 100, "G": 200, "B": 150 } ``` + The following table shows examples of rendering differences for each value. -[`style`](#style-values) | `explode` | `empty` | `string` | `array` | `object` ------------ | ------ | -------- | -------- | -------- | ------- -matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 -matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 -label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 -label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 -form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 -form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 -simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 -simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 -spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 -pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200\|B\|150 -deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 +| [`style`](#style-values) | `explode` | `empty` | `string` | `array` | `object` | +| ------------------------ | --------- | ------- | ----------- | ----------------------------------- | -------------------------------------- | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue.black.brown | .R.100.G.200.B.150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +| simple | false | n/a | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | n/a | blue | blue,black,brown | R=100,G=200,B=150 | +| spaceDelimited | false | n/a | n/a | blue%20black%20brown | R%20100%20G%20200%20B%20150 | +| pipeDelimited | false | n/a | n/a | blue\|black\|brown | R\|100\|G\|200\|B\|150 | +| deepObject | true | n/a | n/a | n/a | color[R]=100&color[G]=200&color[B]=150 | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1124,6 +1118,7 @@ style: simple ``` A path parameter of a string value: + ```json { "name": "username", @@ -1146,6 +1141,7 @@ schema: ``` An optional query parameter of a string value, allowing multiple values by repeating the query parameter: + ```json { "name": "id", @@ -1177,6 +1173,7 @@ explode: true ``` A free-form query parameter, allowing undefined parameters of a specific type: + ```json { "in": "query", @@ -1185,7 +1182,7 @@ A free-form query parameter, allowing undefined parameters of a specific type: "type": "object", "additionalProperties": { "type": "integer" - }, + } }, "style": "form" } @@ -1211,10 +1208,7 @@ A complex parameter using `content` to define serialization: "application/json": { "schema": { "type": "object", - "required": [ - "lat", - "long" - ], + "required": ["lat", "long"], "properties": { "lat": { "type": "number" @@ -1251,18 +1245,19 @@ content: Describes a single request body. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. +| Field Name | Type | Description | +| ------------------------------------------------ | :----------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). ##### Request Body Examples A request body with a referenced model definition. + ```json { "description": "user to add to the system", @@ -1272,36 +1267,36 @@ A request body with a referenced model definition. "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User Example", - "externalValue": "https://foo.bar/examples/user-example.json" - } + "user": { + "summary": "User Example", + "externalValue": "https://foo.bar/examples/user-example.json" } + } }, "application/xml": { "schema": { "$ref": "#/components/schemas/User" }, "examples": { - "user" : { - "summary": "User example in XML", - "externalValue": "https://foo.bar/examples/user-example.xml" - } + "user": { + "summary": "User example in XML", + "externalValue": "https://foo.bar/examples/user-example.xml" } + } }, "text/plain": { "examples": { - "user" : { - "summary": "User example in Plain text", - "externalValue": "https://foo.bar/examples/user-example.txt" + "user": { + "summary": "User example in Plain text", + "externalValue": "https://foo.bar/examples/user-example.txt" } } }, "*/*": { "examples": { - "user" : { - "summary": "User example in other format", - "externalValue": "https://foo.bar/examples/user-example.whatever" + "user": { + "summary": "User example in other format", + "externalValue": "https://foo.bar/examples/user-example.whatever" } } } @@ -1312,33 +1307,34 @@ A request body with a referenced model definition. ```yaml description: user to add to the system content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User Example - externalValue: 'https://foo.bar/examples/user-example.json' - 'application/xml': + externalValue: "https://foo.bar/examples/user-example.json" + "application/xml": schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User example in XML - externalValue: 'https://foo.bar/examples/user-example.xml' - 'text/plain': + externalValue: "https://foo.bar/examples/user-example.xml" + "text/plain": examples: user: summary: User example in Plain text - externalValue: 'https://foo.bar/examples/user-example.txt' - '*/*': + externalValue: "https://foo.bar/examples/user-example.txt" + "*/*": examples: user: summary: User example in other format - externalValue: 'https://foo.bar/examples/user-example.whatever' + externalValue: "https://foo.bar/examples/user-example.whatever" ``` A body parameter that is an array of string values: + ```json { "description": "user to add to the system", @@ -1367,17 +1363,18 @@ content: type: string ``` - #### Media Type Object + Each Media Type Object provides schema and examples for the media type identified by its key. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -schema | [Schema Object](#schema-object) | The schema defining the content of the request, response, or parameter. -example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. -examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. -encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. + +| Field Name | Type | Description | +| ---------------------------------------- | :----------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) | The schema defining the content of the request, response, or parameter. | +| example | Any | Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The `example` field is mutually exclusive of the `examples` field. Furthermore, if referencing a `schema` which contains an example, the `example` value SHALL _override_ the example provided by the schema. | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The `examples` field is mutually exclusive of the `example` field. Furthermore, if referencing a `schema` which contains an example, the `examples` value SHALL _override_ the example provided by the schema. | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1387,30 +1384,29 @@ This object MAY be extended with [Specification Extensions](#specification-exten { "application/json": { "schema": { - "$ref": "#/components/schemas/Pet" + "$ref": "#/components/schemas/Pet" }, "examples": { - "cat" : { + "cat": { "summary": "An example of a cat", - "value": - { - "name": "Fluffy", - "petType": "Cat", - "color": "White", - "gender": "male", - "breed": "Persian" - } + "value": { + "name": "Fluffy", + "petType": "Cat", + "color": "White", + "gender": "male", + "breed": "Persian" + } }, "dog": { "summary": "An example of a dog with a cat's name", - "value" : { + "value": { "name": "Puma", "petType": "Dog", "color": "Black", "gender": "Female", "breed": "Mixed" }, - "frog": { + "frog": { "$ref": "#/components/examples/frog-example" } } @@ -1450,7 +1446,7 @@ In contrast with the 2.0 specification, `file` input/output content in OpenAPI i In contrast with the 3.0 specification, the `format` keyword has no effect on the content-encoding of the schema. JSON Schema offers a `contentEncoding` keyword, which may be used to specify the `Content-Encoding` for the schema. The `contentEncoding` keyword supports all encodings defined in [RFC4648](https://tools.ietf.org/html/rfc4648), including "base64" and "base64url", as well as "quoted-printable" from [RFC2045](https://tools.ietf.org/html/rfc2045#section-6.7). The encoding specified by the `contentEncoding` keyword is independent of an encoding specified by the `Content-Type` header in the request or response or metadata of a multipart body -- when both are present, the encoding specified in the `contentEncoding` is applied first and then the encoding specified in the `Content-Type` header. -JSON Schema also offers a `contentMediaType` keyword. However, when the media type is already specified by the Media Type Object's key, or by the `contentType` field of an [Encoding Object](#encoding-object), the `contentMediaType` keyword SHALL be ignored if present. +JSON Schema also offers a `contentMediaType` keyword. However, when the media type is already specified by the Media Type Object's key, or by the `contentType` field of an [Encoding Object](#encoding-object), the `contentMediaType` keyword SHALL be ignored if present. Examples: @@ -1459,27 +1455,27 @@ Content transferred in binary (octet-stream) MAY omit `schema`: ```yaml # a PNG image as a binary file: content: - image/png: {} + image/png: {} ``` ```yaml # an arbitrary binary file: content: - application/octet-stream: {} + application/octet-stream: {} ``` Binary content transferred with base64 encoding: ```yaml content: - image/png: - schema: - type: string - contentMediaType: image/png - contentEncoding: base64 + image/png: + schema: + type: string + contentMediaType: image/png + contentEncoding: base64 ``` -Note that the `Content-Type` remains `image/png`, describing the semantics of the payload. The JSON Schema `type` and `contentEncoding` fields explain that the payload is transferred as text. The JSON Schema `contentMediaType` is technically redundant, but can be used by JSON Schema tools that may not be aware of the OpenAPI context. +Note that the `Content-Type` remains `image/png`, describing the semantics of the payload. The JSON Schema `type` and `contentEncoding` fields explain that the payload is transferred as text. The JSON Schema `contentMediaType` is technically redundant, but can be used by JSON Schema tools that may not be aware of the OpenAPI context. These examples apply to either input payloads of file uploads or response payloads. @@ -1539,23 +1535,23 @@ requestBody: properties: {} ``` -In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. +In this example, the contents in the `requestBody` MUST be stringified per [RFC1866](https://tools.ietf.org/html/rfc1866/) when passed to the server. In addition, the `address` field complex object will be stringified. When passing complex objects in the `application/x-www-form-urlencoded` content type, the default serialization strategy of such properties is described in the [`Encoding Object`](#encoding-object)'s [`style`](#encodingStyle) property as `form`. ##### Special Considerations for `multipart` Content -It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. +It is common to use `multipart/form-data` as a `Content-Type` when transferring request bodies to operations. In contrast to 2.0, a `schema` is REQUIRED to define the input parameters to the operation when using `multipart` content. This supports complex structures as well as supporting mechanisms for multiple file uploads. In a `multipart/form-data` request body, each schema property, or each element of a schema array property, takes a section in the payload with an internal header as defined by [RFC7578](https://tools.ietf.org/html/rfc7578). The serialization strategy for each property of a `multipart/form-data` request body can be specified in an associated [`Encoding Object`](#encoding-object). When passing in `multipart` types, boundaries MAY be used to separate sections of the content being transferred – thus, the following default `Content-Type`s are defined for `multipart`: -* If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` -* If the property is complex, or an array of complex values, the default Content-Type is `application/json` -* If the property is a `type: string` with a `contentEncoding`, the default Content-Type is `application/octet-stream` +- If the property is a primitive, or an array of primitive values, the default Content-Type is `text/plain` +- If the property is complex, or an array of complex values, the default Content-Type is `application/json` +- If the property is a `type: string` with a `contentEncoding`, the default Content-Type is `application/octet-stream` -Per the JSON Schema specification, `contentMediaType` without `contentEncoding` present is treated as if `contentEncoding: identity` were present. While useful for embedding text documents such as `text/html` into JSON strings, it is not useful for a `multipart/form-data` part, as it just causes the document to be treated as `text/plain` instead of its actual media type. Use the Encoding Object without `contentMediaType` if no `contentEncoding` is required. +Per the JSON Schema specification, `contentMediaType` without `contentEncoding` present is treated as if `contentEncoding: identity` were present. While useful for embedding text documents such as `text/html` into JSON strings, it is not useful for a `multipart/form-data` part, as it just causes the document to be treated as `text/plain` instead of its actual media type. Use the Encoding Object without `contentMediaType` if no `contentEncoding` is required. Examples: @@ -1588,23 +1584,24 @@ requestBody: type: array items: type: object - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" ``` -An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. +An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies. This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies. #### Encoding Object A single encoding definition applied to a single schema property. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `object` - `application/json`; for `array` – the default is defined based on the inner type; for all other cases the default is `application/octet-stream`. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. -style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encodingContentType) (implicit or explicit) SHALL be ignored. -explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encodingContentType) (implicit or explicit) SHALL be ignored. -allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encodingContentType) (implicit or explicit) SHALL be ignored. + +| Field Name | Type | Description | +| ------------------------------------------------- | :-------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| contentType | `string` | The Content-Type for encoding a specific property. Default value depends on the property type: for `object` - `application/json`; for `array` – the default is defined based on the inner type; for all other cases the default is `application/octet-stream`. The value can be a specific media type (e.g. `application/json`), a wildcard media type (e.g. `image/*`), or a comma-separated list of the two types. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers, for example `Content-Disposition`. `Content-Type` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a `multipart`. | +| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameterStyle) property. The behavior follows the same values as `query` parameters, including default values. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encodingContentType) (implicit or explicit) SHALL be ignored. | +| explode | `boolean` | When this is true, property 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 properties this property has no effect. When [`style`](#encodingStyle) is `form`, the default value is `true`. For all other styles, the default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encodingContentType) (implicit or explicit) SHALL be ignored. | +| allowReserved | `boolean` | Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-2.2) `:/?#[]@!$&'()*+,;=` to be included without percent-encoding. The default value is `false`. This property SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encodingContentType) (implicit or explicit) SHALL be ignored. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1661,15 +1658,16 @@ response code is provided it SHOULD be the response for a successful operation call. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. + +| Field Name | Type | Description | +| -------------------------------------- | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------- | +| default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. | ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -[HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. +| Field Pattern | Type | Description | +| ------------------------------------------------------------------ | :--------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `[200-299]`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1703,31 +1701,33 @@ A 200 response for a successful operation and a default response for others (imp ``` ```yaml -'200': +"200": description: a pet to be returned content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: Unexpected error content: application/json: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` #### Response Object + Describes a single response from an API Operation, including design-time, static `links` to operations based on the response. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -description | `string` | **REQUIRED**. A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. -content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/* -links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). + +| Field Name | Type | Description | +| --------------------------------------------- | :-------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | **REQUIRED**. A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#page-22) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/\* | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1758,7 +1758,7 @@ content: schema: type: array items: - $ref: '#/components/schemas/VeryComplexType' + $ref: "#/components/schemas/VeryComplexType" ``` Response with a string type: @@ -1773,7 +1773,6 @@ Response with a string type: } } } - } ``` @@ -1827,7 +1826,7 @@ content: text/plain: schema: type: string - example: 'whoa!' + example: "whoa!" headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period @@ -1864,9 +1863,10 @@ The key value used to identify the path item object is an expression, evaluated To describe incoming requests from the API provider independent from another API call, use the [`webhooks`](#oasWebhooks) field. ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{expression} | [Path Item Object](#path-item-object) \| [Reference Object](#reference-object) | A Path Item Object, or a reference to one, used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. + +| Field Pattern | Type | Description | +| --------------------------------------------- | :----------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {expression} | [Path Item Object](#path-item-object) \| [Reference Object](#reference-object) | A Path Item Object, or a reference to one, used to define a callback request and expected responses. A [complete example](../examples/v3.0/callback-example.yaml) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1900,34 +1900,33 @@ Location: https://example.org/subscription/1 The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. -Expression | Value ----|:--- -$url | https://example.org/subscribe/myevent?queryUrl=https://clientdomain.com/stillrunning -$method | POST -$request.path.eventType | myevent -$request.query.queryUrl | https://clientdomain.com/stillrunning -$request.header.content-Type | application/json -$request.body#/failedUrl | https://clientdomain.com/failed -$request.body#/successUrls/2 | https://clientdomain.com/medium -$response.header.Location | https://example.org/subscription/1 - +| Expression | Value | +| ---------------------------- | :----------------------------------------------------------------------------------- | +| $url | https://example.org/subscribe/myevent?queryUrl=https://clientdomain.com/stillrunning | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | https://clientdomain.com/stillrunning | +| $request.header.content-Type | application/json | +| $request.body#/failedUrl | https://clientdomain.com/failed | +| $request.body#/successUrls/2 | https://clientdomain.com/medium | +| $response.header.Location | https://example.org/subscription/1 | ##### Callback Object Examples -The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is an example of how to use a callback object to describe a WebHook callback that goes with the subscription operation to enable registering for the WebHook. +The following example uses the user provided `queryUrl` query string parameter to define the callback URL. This is an example of how to use a callback object to describe a WebHook callback that goes with the subscription operation to enable registering for the WebHook. ```yaml myCallback: - '{$request.query.queryUrl}': + "{$request.query.queryUrl}": post: requestBody: description: Callback payload content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` @@ -1935,33 +1934,34 @@ The following example shows a callback where the server is hard-coded, but the q ```yaml transactionCallback: - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + "http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}": post: requestBody: description: Callback payload content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` #### Example Object ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -summary | `string` | Short description for the example. -description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. -externalValue | `string` | A URI 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. See the rules for resolving [Relative References](#relative-references-in-uris). + +| Field Name | Type | Description | +| ------------------------------------------------ | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | Short description for the example. | +| description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | +| externalValue | `string` | A URI 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. See the rules for resolving [Relative References](#relative-references-in-uris). | This object MAY be extended with [Specification Extensions](#specification-extensions). In all cases, the example value is expected to be compatible with the type schema -of its associated value. Tooling implementations MAY choose to +of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible. ##### Example Object Examples @@ -1971,58 +1971,57 @@ In a request body: ```yaml requestBody: content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" examples: foo: summary: A foo example - value: {"foo": "bar"} + value: { "foo": "bar" } bar: summary: A bar example - value: {"bar": "baz"} - 'application/xml': + value: { "bar": "baz" } + "application/xml": examples: xmlExample: summary: This is an example in XML - externalValue: 'https://example.org/examples/address-example.xml' - 'text/plain': + externalValue: "https://example.org/examples/address-example.xml" + "text/plain": examples: textExample: summary: This is a text example - externalValue: 'https://foo.bar/examples/address-example.txt' + externalValue: "https://foo.bar/examples/address-example.txt" ``` In a parameter: ```yaml parameters: - - name: 'zipCode' - in: 'query' + - name: "zipCode" + in: "query" schema: - type: 'string' - format: 'zip-code' + type: "string" + format: "zip-code" examples: zip-example: - $ref: '#/components/examples/zip-example' + $ref: "#/components/examples/zip-example" ``` In a response: ```yaml responses: - '200': + "200": description: your car appointment has been booked content: application/json: schema: - $ref: '#/components/schemas/SuccessResponse' + $ref: "#/components/schemas/SuccessResponse" examples: confirmation-success: - $ref: '#/components/examples/confirmation-success' + $ref: "#/components/examples/confirmation-success" ``` - #### Link Object The `Link object` represents a possible design-time link for a response. @@ -2030,18 +2029,18 @@ The presence of a link does not guarantee the caller's ability to successfully i Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response. -For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. +For computing links, and providing instructions to execute them, a [runtime expression](#runtime-expressions) is used for accessing values in an operation and using them as parameters while invoking the linked operation. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -operationRef | `string` | A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. See the rules for resolving [Relative References](#relative-references-in-uris). -operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. -parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). -requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. -description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -server | [Server Object](#server-object) | A server object to be used by the target operation. +| Field Name | Type | Description | +| ------------------------------------------- | :--------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| operationRef | `string` | A relative or absolute URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI definition. See the rules for resolving [Relative References](#relative-references-in-uris). | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the [parameter location](#parameterIn) `[{in}.]{name}` for operations that use the same parameter name in different locations (e.g. path.id). | +| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#server-object) | A server object to be used by the target operation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2058,15 +2057,15 @@ Computing a link from a request operation where the `$request.path.id` is used t paths: /users/{id}: parameters: - - name: id - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: id + in: path + required: true + description: the user identifier, as userId + schema: + type: string get: responses: - '200': + "200": description: the user being returned content: application/json: @@ -2086,17 +2085,17 @@ paths: # the path item of the linked operation /users/{userid}/address: parameters: - - name: userid - in: path - required: true - description: the user identifier, as userId - schema: - type: string + - name: userid + in: path + required: true + description: the user identifier, as userId + schema: + type: string # linked operation get: operationId: getUserAddress responses: - '200': + "200": description: the user's address ``` @@ -2117,7 +2116,6 @@ Clients follow all links at their discretion. Neither permissions, nor the capability to make a successful call to that link, is guaranteed solely by the existence of a relationship. - ##### OperationRef Examples As references to `operationId` MAY NOT be possible (the `operationId` is an optional @@ -2127,7 +2125,7 @@ field in an [Operation Object](#operation-object)), references MAY also be made links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: '#/paths/~12.0~1repositories~1{username}/get' + operationRef: "#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2138,7 +2136,7 @@ or an absolute `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: 'https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get' + operationRef: "https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get" parameters: username: $response.body#/username ``` @@ -2146,7 +2144,6 @@ links: Note that in the use of `operationRef`, the _escaped forward-slash_ is necessary when using JSON references. - ##### Runtime Expressions Runtime expressions allow defining values based on information that will only be available within the HTTP message in an actual API call. @@ -2158,7 +2155,7 @@ The runtime expression is defined by the following [ABNF](https://tools.ietf.org expression = ( "$url" / "$method" / "$statusCode" / "$request." source / "$response." source ) source = ( header-reference / query-reference / path-reference / body-reference ) header-reference = "header." token - query-reference = "query." name + query-reference = "query." name path-reference = "path." name body-reference = "body" ["#" json-pointer ] json-pointer = *( "/" reference-token ) @@ -2181,15 +2178,15 @@ The table below provides examples of runtime expressions and examples of their u ##### Examples -Source Location | example expression | notes ----|:---|:---| -HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. -Requested media type | `$request.header.accept` | -Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. -Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. -Request URL | `$url` | -Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. -Response header | `$response.header.Server` | Single header values only are available +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | Runtime expressions preserve the type of the referenced value. Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. @@ -2227,11 +2224,12 @@ Adds metadata to a single tag that is used by the [Operation Object](#operation- It is not mandatory to have a Tag Object per tag defined in the Operation Object instances. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | **REQUIRED**. The name of the tag. -description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. + +| Field Name | Type | Description | +| ------------------------------------------ | :-------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the tag. | +| description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2239,8 +2237,8 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```json { - "name": "pet", - "description": "Pets operations" + "name": "pet", + "description": "Pets operations" } ``` @@ -2249,7 +2247,6 @@ name: pet description: Pets operations ``` - #### Reference Object A simple object to allow referencing other components in the OpenAPI document, internally and externally. @@ -2259,11 +2256,12 @@ The `$ref` string value contains a URI [RFC3986](https://tools.ietf.org/html/rfc See the rules for resolving [Relative References](#relative-references-in-uris). ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -$ref | `string` | **REQUIRED**. The reference identifier. This MUST be in the form of a URI. -summary | `string` | A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. -description | `string` | A description which by default SHOULD override that of the referenced component. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. + +| Field Name | Type | Description | +| ---------------------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | **REQUIRED**. The reference identifier. This MUST be in the form of a URI. | +| summary | `string` | A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. | +| description | `string` | A description which by default SHOULD override that of the referenced component. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. | This object cannot be extended with additional properties and any properties added SHALL be ignored. @@ -2273,15 +2271,16 @@ Note that this restriction on additional properties is a difference between Refe ```json { - "$ref": "#/components/schemas/Pet" + "$ref": "#/components/schemas/Pet" } ``` ```yaml -$ref: '#/components/schemas/Pet' +$ref: "#/components/schemas/Pet" ``` ##### Relative Schema Document Example + ```json { "$ref": "Pet.json" @@ -2293,6 +2292,7 @@ $ref: Pet.yaml ``` ##### Relative Documents With Embedded Schema Example + ```json { "$ref": "definitions.json#/Pet" @@ -2330,28 +2330,29 @@ The OpenAPI Specification's base vocabulary is comprised of the following keywor ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. -xml | [XML Object](#xml-object) | 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. -externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. -example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.

**Deprecated:** The `example` property has been deprecated in favor of the JSON Schema `examples` keyword. Use of `example` is discouraged, and later versions of this specification may remove it. +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| discriminator | [Discriminator Object](#discriminator-object) | 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](#composition-and-inheritance-polymorphism) for more details. | +| xml | [XML Object](#xml-object) | 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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.

**Deprecated:** The `example` property has been deprecated in favor of the JSON Schema `examples` keyword. Use of `example` is discouraged, and later versions of this specification may remove it. | This object MAY be extended with [Specification Extensions](#specification-extensions), though as noted, additional properties MAY omit the `x-` prefix within this object. ###### Composition and Inheritance (Polymorphism) The OpenAPI Specification allows combining and extending model definitions using the `allOf` property of JSON Schema, in effect offering model composition. -`allOf` takes an array of object definitions that are validated *independently* but together compose a single object. +`allOf` takes an array of object definitions that are validated _independently_ but together compose a single object. While composition offers model extensibility, it does not imply a hierarchy between the models. To support polymorphism, the OpenAPI Specification adds the `discriminator` field. When used, the `discriminator` will be the name of the property that decides which schema definition validates the structure of the model. As such, the `discriminator` field MUST be a required field. There are two ways to define the value of a discriminator for an inheriting instance. + - Use the schema name. - Override the schema name by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. -As such, inline schema definitions, which do not have a given id, *cannot* be used in polymorphism. + As such, inline schema definitions, which do not have a given id, _cannot_ be used in polymorphism. ###### XML Modeling @@ -2389,9 +2390,7 @@ format: email ```json { "type": "object", - "required": [ - "name" - ], + "required": ["name"], "properties": { "name": { "type": "string" @@ -2411,12 +2410,12 @@ format: email ```yaml type: object required: -- name + - name properties: name: type: string address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" age: type: integer format: int32 @@ -2456,7 +2455,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/components/schemas/ComplexModel' + $ref: "#/components/schemas/ComplexModel" ``` ###### Model with Example @@ -2473,9 +2472,7 @@ additionalProperties: "type": "string" } }, - "required": [ - "name" - ], + "required": ["name"], "example": { "name": "Puma", "id": 1 @@ -2492,7 +2489,7 @@ properties: name: type: string required: -- name + - name example: name: Puma id: 1 @@ -2506,10 +2503,7 @@ example: "schemas": { "ErrorModel": { "type": "object", - "required": [ - "message", - "code" - ], + "required": ["message", "code"], "properties": { "message": { "type": "string" @@ -2528,9 +2522,7 @@ example: }, { "type": "object", - "required": [ - "rootCause" - ], + "required": ["rootCause"], "properties": { "rootCause": { "type": "string" @@ -2550,8 +2542,8 @@ components: ErrorModel: type: object required: - - message - - code + - message + - code properties: message: type: string @@ -2561,13 +2553,13 @@ components: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/components/schemas/ErrorModel' - - type: object - required: - - rootCause - properties: - rootCause: - type: string + - $ref: "#/components/schemas/ErrorModel" + - type: object + required: + - rootCause + properties: + rootCause: + type: string ``` ###### Models with Polymorphism Support @@ -2589,10 +2581,7 @@ components: "type": "string" } }, - "required": [ - "name", - "petType" - ] + "required": ["name", "petType"] }, "Cat": { "description": "A representation of a cat. Note that `Cat` will be used as the discriminator value.", @@ -2607,17 +2596,10 @@ components: "type": "string", "description": "The measured skill for hunting", "default": "lazy", - "enum": [ - "clueless", - "lazy", - "adventurous", - "aggressive" - ] + "enum": ["clueless", "lazy", "adventurous", "aggressive"] } }, - "required": [ - "huntingSkill" - ] + "required": ["huntingSkill"] } ] }, @@ -2638,9 +2620,7 @@ components: "minimum": 0 } }, - "required": [ - "packSize" - ] + "required": ["packSize"] } ] } @@ -2662,51 +2642,52 @@ components: petType: type: string required: - - name - - petType - Cat: ## "Cat" will be used as the discriminator value + - name + - petType + Cat: ## "Cat" will be used as the discriminator value description: A representation of a cat allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - huntingSkill: - type: string - description: The measured skill for hunting - enum: - - clueless - - lazy - - adventurous - - aggressive - required: - - huntingSkill - Dog: ## "Dog" will be used as the discriminator value + - $ref: "#/components/schemas/Pet" + - type: object + properties: + huntingSkill: + type: string + description: The measured skill for hunting + enum: + - clueless + - lazy + - adventurous + - aggressive + required: + - huntingSkill + Dog: ## "Dog" will be used as the discriminator value description: A representation of a dog allOf: - - $ref: '#/components/schemas/Pet' - - type: object - properties: - packSize: - type: integer - format: int32 - description: the size of the pack the dog is from - default: 0 - minimum: 0 - required: - - packSize + - $ref: "#/components/schemas/Pet" + - type: object + properties: + packSize: + type: integer + format: int32 + description: the size of the pack the dog is from + default: 0 + minimum: 0 + required: + - packSize ``` #### Discriminator Object -When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the document of an alternative schema based on the value associated with it. +When request bodies or response payloads may be one of a number of different schemas, a `discriminator` object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the document of an alternative schema based on the value associated with it. When using the discriminator, _inline_ schemas will not be considered. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. - mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. + +| Field Name | Type | Description | +| ------------------------------------------- | :---------------------: | --------------------------------------------------------------------------------------------- | +| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminator value. | +| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or references. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2717,25 +2698,24 @@ In OAS 3.0, a response payload MAY be described to be exactly one of any number ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" ``` -which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: - +which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. In this case, a discriminator MAY act as a "hint" to shortcut validation and selection of the matching schema which may be a costly operation, depending on the complexity of the schema. We can then describe exactly which field tells us which schema to use: ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" discriminator: propertyName: petType ``` -The expectation now is that a property with name `petType` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: +The expectation now is that a property with name `petType` _MUST_ be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload: ```json { @@ -2751,22 +2731,22 @@ In scenarios where the value of the discriminator field does not match the schem ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' - - $ref: 'https://gigantic-server.com/schemas/Monster/schema.json' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" + - $ref: "https://gigantic-server.com/schemas/Monster/schema.json" discriminator: propertyName: petType mapping: - dog: '#/components/schemas/Dog' - monster: 'https://gigantic-server.com/schemas/Monster/schema.json' + dog: "#/components/schemas/Dog" + monster: "https://gigantic-server.com/schemas/Monster/schema.json" ``` -Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. +Here the discriminator _value_ of `dog` will map to the schema `#/components/schemas/Dog`, rather than the default (implicit) value of `Dog`. If the discriminator _value_ does not match an implicit or explicit mapping, no schema can be determined and validation SHOULD fail. Mapping keys MUST be string values, but tooling MAY convert response values to strings for comparison. When used in conjunction with the `anyOf` construct, the use of the discriminator can avoid ambiguity where multiple schemas may satisfy a single payload. -In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. +In both the `oneOf` and `anyOf` use cases, all possible schemas MUST be listed explicitly. To avoid redundancy, the discriminator MAY be added to a parent schema definition, and all schemas comprising the parent schema in an `allOf` construct may be used as an alternate schema. For example: @@ -2776,7 +2756,7 @@ components: Pet: type: object required: - - petType + - petType properties: petType: type: string @@ -2786,28 +2766,28 @@ components: dog: Dog Cat: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Cat` - properties: - name: - type: string + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Cat` + properties: + name: + type: string Dog: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Dog` - properties: - bark: - type: string + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Dog` + properties: + bark: + type: string Lizard: allOf: - - $ref: '#/components/schemas/Pet' - - type: object - # all other properties specific to a `Lizard` - properties: - lovesRocks: - type: boolean + - $ref: "#/components/schemas/Pet" + - type: object + # all other properties specific to a `Lizard` + properties: + lovesRocks: + type: boolean ``` a payload like this: @@ -2819,7 +2799,7 @@ a payload like this: } ``` -will indicate that the `Cat` schema be used. Likewise this schema: +will indicate that the `Cat` schema be used. Likewise this schema: ```json { @@ -2830,22 +2810,22 @@ will indicate that the `Cat` schema be used. Likewise this schema: will map to `Dog` because of the definition in the `mapping` element. - #### XML Object A metadata object that allows for more fine-tuned XML model definitions. -When using arrays, XML element names are *not* inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. +When using arrays, XML element names are _not_ inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information. See examples for expected behavior. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. -namespace | `string` | The URI of the namespace definition. This MUST be in the form of an absolute URI. -prefix | `string` | The prefix to be used for the [name](#xmlName). -attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. -wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). + +| Field Name | Type | Description | +| ------------------------------------ | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `array` (outside the `items`), it will affect the wrapping element and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | The URI of the namespace definition. This MUST be in the form of an absolute URI. | +| prefix | `string` | The prefix to be used for the [name](#xmlName). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `array` (outside the `items`). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2859,9 +2839,9 @@ Basic string property: ```json { - "animals": { - "type": "string" - } + "animals": { + "type": "string" + } } ``` @@ -2878,12 +2858,12 @@ Basic string array property ([`wrapped`](#xmlWrapped) is `false` by default): ```json { - "animals": { - "type": "array", - "items": { - "type": "string" - } + "animals": { + "type": "array", + "items": { + "type": "string" } + } } ``` @@ -2924,7 +2904,6 @@ animals: ... ``` - ###### XML Attribute, Prefix and Namespace In this example, a full model definition is shown. @@ -3192,16 +3171,17 @@ Supported schemes are HTTP authentication, an API key (either as a header, a coo Please note that as of 2020, the implicit flow is about to be deprecated by [OAuth 2.0 Security Best Current Practice](https://tools.ietf.org/html/draft-ietf-oauth-security-topics). Recommended for most use case is Authorization Code Grant flow with PKCE. ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"mutualTLS"`, `"oauth2"`, `"openIdConnect"`. -description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. -in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. -scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). -bearerFormat | `string` | `http` (`"bearer"`) | 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. -flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. -openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. The OpenID Connect standard requires the use of TLS. + +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------- | :---------------------------------------: | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"mutualTLS"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). | +| bearerFormat | `string` | `http` (`"bearer"`) | 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. | +| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. The OpenID Connect standard requires the use of TLS. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3243,7 +3223,7 @@ in: header { "type": "http", "scheme": "bearer", - "bearerFormat": "JWT", + "bearerFormat": "JWT" } ``` @@ -3285,12 +3265,13 @@ flows: Allows configuration of the supported OAuth Flows. ##### Fixed Fields -Field Name | Type | Description ----|:---:|--- -implicit| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow -password| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow -clientCredentials| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. -authorizationCode| [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. + +| Field Name | Type | Description | +| ----------------------------------------------------------- | :-------------------------------------: | ---------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | +| clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3299,12 +3280,13 @@ This object MAY be extended with [Specification Extensions](#specification-exten Configuration details for a supported OAuth Flow ##### Fixed Fields -Field Name | Type | Applies To | Description ----|:---:|---|--- -authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. -tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. -refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. -scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. + +| Field Name | Type | Applies To | Description | +| -------------------------------------------------------- | :---------------------: | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3361,9 +3343,9 @@ When a list of Security Requirement Objects is defined on the [OpenAPI Object](# ##### Patterned Fields -Field Pattern | Type | Description ----|:---:|--- -{name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. +| Field Pattern | Type | Description | +| --------------------------------------------- | :--------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| {name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#componentsSecuritySchemes) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. | ##### Security Requirement Object Examples @@ -3383,17 +3365,14 @@ api_key: [] ```json { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ``` ```yaml petstore_auth: -- write:pets -- read:pets + - write:pets + - read:pets ``` ###### Optional OAuth2 Security @@ -3405,10 +3384,7 @@ Optional OAuth2 security as would be defined in an Ope "security": [ {}, { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] } @@ -3418,8 +3394,8 @@ Optional OAuth2 security as would be defined in an Ope security: - {} - petstore_auth: - - write:pets - - read:pets + - write:pets + - read:pets ``` ### Specification Extensions @@ -3428,9 +3404,9 @@ While the OpenAPI Specification tries to accommodate most use cases, additional The extensions properties are implemented as patterned fields that are always prefixed by `"x-"`. -Field Pattern | Type | Description ----|:---:|--- -^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. Field names beginning `x-oai-` and `x-oas-` are reserved for uses defined by the [OpenAPI Initiative](https://www.openapis.org/). The value can be `null`, a primitive, an array or an object. +| Field Pattern | Type | Description | +| -------------------------------- | :--: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. Field names beginning `x-oai-` and `x-oas-` are reserved for uses defined by the [OpenAPI Initiative](https://www.openapis.org/). The value can be `null`, a primitive, an array or an object. | The extensions may or may not be supported by the available tooling, but those may be extended as well to add requested support (if tools are internal or open-sourced). @@ -3446,23 +3422,22 @@ Two examples of this: 1. The [Paths Object](#paths-object) MAY be present but empty. It may be counterintuitive, but this may tell the viewer that they got to the right place, but can't access any documentation. They would still have access to at least the [Info Object](#info-object) which may contain additional information regarding authentication. 2. The [Path Item Object](#path-item-object) MAY be empty. In this case, the viewer will be aware that the path exists, but will not be able to see any of its operations or parameters. This is different from hiding the path itself from the [Paths Object](#paths-object), because the user will be aware of its existence. This allows the documentation provider to finely control what the viewer can see. - ## Appendix A: Revision History -Version | Date | Notes ---- | --- | --- -3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0 -3.1.0-rc1 | 2020-10-08 | rc1 of the 3.1 specification -3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification -3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 -3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 -3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 -3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 -3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification -3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification -3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification -2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative -2.0 | 2014-09-08 | Release of Swagger 2.0 -1.2 | 2014-03-14 | Initial release of the formal document. -1.1 | 2012-08-22 | Release of Swagger 1.1 -1.0 | 2011-08-10 | First release of the Swagger Specification +| Version | Date | Notes | +| --------- | ---------- | ------------------------------------------------- | +| 3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0 | +| 3.1.0-rc1 | 2020-10-08 | rc1 of the 3.1 specification | +| 3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification | +| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | +| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | +| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | diff --git a/3.1/3.1.1.md b/3.1/3.1.1.md index b2db701..e132d41 100644 --- a/3.1/3.1.1.md +++ b/3.1/3.1.1.md @@ -116,8 +116,8 @@ Patterned fields MUST have unique names within the containing object. In order to preserve the ability to round-trip between YAML and JSON formats, YAML version [1.2](https://yaml.org/spec/1.2/spec.html) is RECOMMENDED along with some additional constraints: -* Tags MUST be limited to those allowed by [YAML's JSON schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231), which defines a subset of the YAML syntax and is unrelated to [[JSON-Schema-2020-12|JSON Schema]]. -* Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](https://yaml.org/spec/1.2/spec.html#id2802346). +- Tags MUST be limited to those allowed by [YAML's JSON schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231), which defines a subset of the YAML syntax and is unrelated to [[JSON-Schema-2020-12|JSON Schema]]. +- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](https://yaml.org/spec/1.2/spec.html#id2802346). **Note:** While APIs may be described by OpenAPI Descriptions in either YAML or JSON format, the API request and response bodies and other content are not required to be JSON or YAML. @@ -137,11 +137,11 @@ This includes a requirement to parse complete documents before deeming a Schema Implementations MAY support complete-document parsing in any of the following ways: -* Detecting OpenAPI or JSON Schema documents using media types -* Detecting OpenAPI documents through the root `openapi` field -* Detecting JSON Schema documents through detecting keywords or otherwise successfully parsing the document in accordance with the JSON Schema specification -* Detecting a document containing a referenceable Object at its root based on the expected type of the reference -* Allowing users to configure the type of documents that might be loaded due to a reference to a non-root Object +- Detecting OpenAPI or JSON Schema documents using media types +- Detecting OpenAPI documents through the root `openapi` field +- Detecting JSON Schema documents through detecting keywords or otherwise successfully parsing the document in accordance with the JSON Schema specification +- Detecting a document containing a referenceable Object at its root based on the expected type of the reference +- Allowing users to configure the type of documents that might be loaded due to a reference to a non-root Object Implementations that parse referenced fragments of OpenAPI content without regard for the content of the rest of the containing document will miss keywords that change the meaning and behavior of the reference target. In particular, failing to take into account keywords that change the base URI introduces security risks by causing references to resolve to unintended URIs, with unpredictable results. @@ -158,9 +158,9 @@ It is the responsibility of an embedding format to define how to parse embedded JSON or YAML objects within an OAD are interpreted as specific Objects (such as [Operation Objects](#operation-object), [Response Objects](#response-object), [Reference Objects](#reference-object), etc.) based on their context. Depending on how references are arranged, a given JSON or YAML object can be interpreted in multiple different contexts: -* As the root object of the [entry document](#openapi-description-structure), which is always interpreted as an OpenAPI Object -* As the Object type implied by its parent Object within the document -* As a reference target, with the Object type matching the reference source's context +- As the root object of the [entry document](#openapi-description-structure), which is always interpreted as an OpenAPI Object +- As the Object type implied by its parent Object within the document +- As a reference target, with the Object type matching the reference source's context If the same JSON/YAML object is parsed multiple times and the respective contexts require it to be parsed as _different_ Object types, the resulting behavior is _implementation defined_, and MAY be treated as an error if detected. An example would be referencing an empty Schema Object under `#/components/schemas` where a Path Item Object is expected, as an empty object is valid for both types. For maximum interoperability, it is RECOMMENDED that OpenAPI Description authors avoid such scenarios. @@ -171,12 +171,12 @@ Several features of this specification require resolution of non-URI-based conne These connections are unambiguously resolved in single-document OADs, but the resolution process in multi-document OADs is _implementation-defined_, within the constraints described in this section. In some cases, an unambiguous URI-based alternative is available, and OAD authors are RECOMMENDED to always use the alternative: -| Source | Target | Alternative | -| ---- | ---- | ---- | -| [Security Requirement Object](#security-requirement-object) `{name}` | [Security Scheme Object](#security-scheme-object) name under the [Components Object](#components-object) | _n/a_ | -| [Discriminator Object](#discriminator-object) `mapping` _(implicit, or explicit name syntax)_ | [Schema Object](#schema-object) name under the Components Object | `mapping` _(explicit URI syntax)_ | -| [Operation Object](#operation-object) `tags` | [Tag Object](#tag-object) `name` (in the [OpenAPI Object](#openapi-object)'s `tags` array) | _n/a_ | -| [Link Object](#link-object) `operationId` | [Path Item Object](#path-item-object) `operationId` | `operationRef` | +| Source | Target | Alternative | +| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------- | +| [Security Requirement Object](#security-requirement-object) `{name}` | [Security Scheme Object](#security-scheme-object) name under the [Components Object](#components-object) | _n/a_ | +| [Discriminator Object](#discriminator-object) `mapping` _(implicit, or explicit name syntax)_ | [Schema Object](#schema-object) name under the Components Object | `mapping` _(explicit URI syntax)_ | +| [Operation Object](#operation-object) `tags` | [Tag Object](#tag-object) `name` (in the [OpenAPI Object](#openapi-object)'s `tags` array) | _n/a_ | +| [Link Object](#link-object) `operationId` | [Path Item Object](#path-item-object) `operationId` | `operationRef` | A fifth implicit connection involves appending the templated URL paths of the [Paths Object](#paths-object) to the appropriate [Server Object](#server-object)'s `url` field. This is unambiguous because only the entry document's Paths Object contributes URLs to the described API. @@ -223,13 +223,13 @@ For the purpose of [JSON Schema validation](https://datatracker.ietf.org/doc/htm The formats defined by the OAS are: -| `format` | JSON Data Type | Comments | -| ---- | ---- | ---- | -| `int32` | number | signed 32 bits | -| `int64` | number | signed 64 bits (a.k.a long) | -| `float` | number | | -| `double` | number | | -| `password` | string | A hint to obscure the value. | +| `format` | JSON Data Type | Comments | +| ---------- | -------------- | ---------------------------- | +| `int32` | number | signed 32 bits | +| `int64` | number | signed 64 bits (a.k.a long) | +| `float` | number | | +| `double` | number | | +| `password` | string | A hint to obscure the value. | As noted under [Data Type](#data-types), both `type: number` and `type: integer` are considered to be numbers in the data model. @@ -237,16 +237,16 @@ As noted under [Data Type](#data-types), both `type: number` and `type: integer` The OAS can describe either _raw_ or _encoded_ binary data. -* **raw binary** is used where unencoded binary data is allowed, such as when sending a binary payload as the entire HTTP message body, or as part of a `multipart/*` payload that allows binary parts -* **encoded binary** is used where binary data is embedded in a text-only format such as `application/json` or `application/x-www-form-urlencoded` (either as a message body or in the URL query string). +- **raw binary** is used where unencoded binary data is allowed, such as when sending a binary payload as the entire HTTP message body, or as part of a `multipart/*` payload that allows binary parts +- **encoded binary** is used where binary data is embedded in a text-only format such as `application/json` or `application/x-www-form-urlencoded` (either as a message body or in the URL query string). In the following table showing how to use Schema Object keywords for binary data, we use `image/png` as an example binary media type. Any binary media type, including `application/octet-stream`, is sufficient to indicate binary content. -| Keyword | Raw | Encoded | Comments | -| ---- | ---- | ---- | ---- | -| `type` | _omit_ | `string` | raw binary is [outside of `type`](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-4.2.3) | -| `contentMediaType` | `image/png` | `image/png` | can sometimes be omitted if redundant (see below) | -| `contentEncoding` | _omit_ | `base64` or `base64url` | other encodings are [allowed](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.3) | +| Keyword | Raw | Encoded | Comments | +| ------------------ | ----------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | +| `type` | _omit_ | `string` | raw binary is [outside of `type`](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-4.2.3) | +| `contentMediaType` | `image/png` | `image/png` | can sometimes be omitted if redundant (see below) | +| `contentEncoding` | _omit_ | `base64` or `base64url` | other encodings are [allowed](https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-8.3) | Note that the encoding indicated by `contentEncoding`, which inflates the size of data in order to represent it as 7-bit ASCII text, is unrelated to HTTP's `Content-Encoding` header, which indicates whether and how a message body has been compressed and is applied after all content serialization described in this section has occurred. Since HTTP allows unencoded binary message bodies, there is no standardized HTTP header for indicating base64 or similar encoding of an entire message body. @@ -254,8 +254,8 @@ Using a `contentEncoding` of `base64url` ensures that URL encoding (as required The `contentMediaType` keyword is redundant if the media type is already set: -* as the key for a [MediaType Object](#media-type-object) -* in the `contentType` field of an [Encoding Object](#encoding-object) +- as the key for a [MediaType Object](#media-type-object) +- in the `contentType` field of an [Encoding Object](#encoding-object) If the [Schema Object](#schema-object) will be processed by a non-OAS-aware JSON Schema implementation, it may be useful to include `contentMediaType` even if it is redundant. However, if `contentMediaType` contradicts a relevant Media Type Object or Encoding Object, then `contentMediaType` SHALL be ignored. @@ -265,10 +265,10 @@ The `maxLength` keyword MAY be used to set an expected upper bound on the length The following table shows how to migrate from OAS 3.0 binary data descriptions, continuing to use `image/png` as the example binary media type: -| OAS < 3.1 | OAS 3.1 | Comments | -| ---- | ---- | ---- | -| type: string
format: binary | contentMediaType: image/png | if redundant, can be omitted, often resulting in an empty [Schema Object](#schema-object) | -| type: string
format: byte | type: string
contentMediaType: image/png
contentEncoding: base64 | note that `base64url` can be used to avoid re-encoding the base64 string to be URL-safe | +| OAS < 3.1 | OAS 3.1 | Comments | +| ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| type: string
format: binary | contentMediaType: image/png | if redundant, can be omitted, often resulting in an empty [Schema Object](#schema-object) | +| type: string
format: byte | type: string
contentMediaType: image/png
contentEncoding: base64 | note that `base64url` can be used to avoid re-encoding the base64 string to be URL-safe | ### Rich Text Formatting @@ -319,18 +319,18 @@ This is the root object of the [OpenAPI Description](#openapi-description). ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the OpenAPI Specification that the OpenAPI Document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI Document. This is _not_ related to the API [`info.version`](#info-version) string. | -| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | -| jsonSchemaDialect | `string` | The default value for the `$schema` keyword within [Schema Objects](#schema-object) contained within this OAS document. This MUST be in the form of a URI. | -| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` field is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#server-url) value of `/`. | -| paths | [Paths Object](#paths-object) | The available paths and operations for the API. | -| webhooks | Map[`string`, [Path Item Object](#path-item-object)] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](https://learn.openapis.org/examples/v3.1/webhook-example.html) is available. | -| components | [Components Object](#components-object) | An element to hold various Objects for the OpenAPI Description. | -| security | [[Security Requirement Object](#security-requirement-object)] | 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. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement (`{}`) can be included in the array. | -| tags | [[Tag Object](#tag-object)] | A list of tags used by the OpenAPI Description 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](#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. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | +| Field Name | Type | Description | +| -------------------------------------------------------- | :-------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions) of the OpenAPI Specification that the OpenAPI Document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI Document. This is _not_ related to the API [`info.version`](#info-version) string. | +| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| jsonSchemaDialect | `string` | The default value for the `$schema` keyword within [Schema Objects](#schema-object) contained within this OAS document. This MUST be in the form of a URI. | +| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` field is not provided, or is an empty array, the default value would be a [Server Object](#server-object) with a [url](#server-url) value of `/`. | +| paths | [Paths Object](#paths-object) | The available paths and operations for the API. | +| webhooks | Map[`string`, [Path Item Object](#path-item-object)] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](https://learn.openapis.org/examples/v3.1/webhook-example.html) is available. | +| components | [Components Object](#components-object) | An element to hold various Objects for the OpenAPI Description. | +| security | [[Security Requirement Object](#security-requirement-object)] | 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. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement (`{}`) can be included in the array. | +| tags | [[Tag Object](#tag-object)] | A list of tags used by the OpenAPI Description 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -341,15 +341,15 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| title | `string` | **REQUIRED**. The title of the API. | -| summary | `string` | A short summary of the API. | -| description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| termsOfService | `string` | A URI for the Terms of Service for the API. This MUST be in the form of a URI. | -| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | -| license | [License Object](#license-object) | The license information for the exposed API. | -| version | `string` | **REQUIRED**. The version of the OpenAPI Document (which is distinct from the [OpenAPI Specification version](#oas-version) or the version of the API being described or the version of the OpenAPI Description). | +| Field Name | Type | Description | +| -------------------------------------------------- | :-------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **REQUIRED**. The title of the API. | +| summary | `string` | A short summary of the API. | +| description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | A URI for the Terms of Service for the API. This MUST be in the form of a URI. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **REQUIRED**. The version of the OpenAPI Document (which is distinct from the [OpenAPI Specification version](#oas-version) or the version of the API being described or the version of the OpenAPI Description). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -395,10 +395,10 @@ Contact information for the exposed API. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | The identifying name of the contact person/organization. | -| url | `string` | The URI for the contact information. This MUST be in the form of a URI. | +| Field Name | Type | Description | +| --------------------------------- | :------: | --------------------------------------------------------------------------------------------------- | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URI for the contact information. This MUST be in the form of a URI. | | email | `string` | The email address of the contact person/organization. This MUST be in the form of an email address. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -425,11 +425,11 @@ License information for the exposed API. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The license name used for the API. | -| identifier | `string` | An [SPDX](https://spdx.org/licenses/) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. | -| url | `string` | A URI for the license used for the API. This MUST be in the form of a URI. The `url` field is mutually exclusive of the `identifier` field. | +| Field Name | Type | Description | +| ------------------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The license name used for the API. | +| identifier | `string` | An [SPDX](https://spdx.org/licenses/) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. | +| url | `string` | A URI for the license used for the API. This MUST be in the form of a URI. The `url` field is mutually exclusive of the `identifier` field. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -453,11 +453,11 @@ An object representing a Server. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in `{`braces`}`. | -| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | +| Field Name | Type | Description | +| -------------------------------------------- | :--------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Variable substitutions will be made when a variable is named in `{`braces`}`. | +| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -545,9 +545,9 @@ servers: description: A user-specific subdomain. Use `demo` for a free sandbox environment. port: enum: - - '8443' - - '443' - default: '8443' + - "8443" + - "443" + default: "8443" basePath: # open meaning there is the opportunity to use special base paths as assigned by the provider, default is `v2` default: v2 @@ -559,11 +559,11 @@ An object representing a Server Variable for server URL template substitution. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. | -| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. If the [`enum`](#server-variable-enum) is defined, the value MUST exist in the enum's values. Note that this behavior is different from the [Schema Object](#schema-object)'s `default` keyword, which documents the receiver's behavior rather than inserting the value into the data. | -| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| Field Name | Type | Description | +| ----------------------------------------------------- | :--------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. | +| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. If the [`enum`](#server-variable-enum) is defined, the value MUST exist in the enum's values. Note that this behavior is different from the [Schema Object](#schema-object)'s `default` keyword, which documents the receiver's behavior rather than inserting the value into the data. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -574,18 +574,18 @@ All objects defined within the Components Object will have no effect on the API ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :---- | ---- | -| schemas | Map[`string`, [Schema Object](#schema-object)] | An object to hold reusable [Schema Objects](#schema-object). | -| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | -| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | -| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | -| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | -| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | -| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | -| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | -| pathItems | Map[`string`, [Path Item Object](#path-item-object)] | An object to hold reusable [Path Item Objects](#path-item-object). | +| Field Name | Type | Description | +| ------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| schemas | Map[`string`, [Schema Object](#schema-object)] | An object to hold reusable [Schema Objects](#schema-object). | +| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | +| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | +| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | +| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | +| securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | +| pathItems | Map[`string`, [Path Item Object](#path-item-object)] | An object to hold reusable [Path Item Objects](#path-item-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -759,7 +759,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GeneralError' + $ref: "#/components/schemas/GeneralError" securitySchemes: api_key: type: apiKey @@ -782,8 +782,8 @@ The path is appended to the URL from the [Server Object](#server-object) in orde ##### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| -------------------------------- | :-----------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The path is **appended** (no relative URL resolution) to the expanded URL from the [Server Object](#server-object)'s `url` field in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -843,14 +843,14 @@ The following may lead to ambiguous resolution: get: description: Returns all pets from the system that the user has access to responses: - '200': + "200": description: A list of pets. content: application/json: schema: type: array items: - $ref: '#/components/schemas/pet' + $ref: "#/components/schemas/pet" ``` #### Path Item Object @@ -861,21 +861,21 @@ The path itself is still exposed to the documentation viewer but they will not k ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| $ref | `string` | Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving [Relative References](#relative-references-in-api-description-uris).

_**Note:** The behavior of `$ref` with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the [Reference Object](#reference-object)._ | -| summary | `string` | An optional string summary, intended to apply to all operations in this path. | -| description | `string` | An optional string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | -| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | -| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | -| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | -| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | -| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | -| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | -| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | -| servers | [[Server Object](#server-object)] | An alternative `servers` array to service all operations in this path. If a `servers` array is specified at the [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | -| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | +| Field Name | Type | Description | +| ----------------------------------------------- | :------------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving [Relative References](#relative-references-in-api-description-uris).

_**Note:** The behavior of `$ref` with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the [Reference Object](#reference-object)._ | +| summary | `string` | An optional string summary, intended to apply to all operations in this path. | +| description | `string` | An optional string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | +| servers | [[Server Object](#server-object)] | An alternative `servers` array to service all operations in this path. If a `servers` array is specified at the [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -937,20 +937,20 @@ get: summary: Find pets by ID operationId: getPetsById responses: - '200': + "200": description: pet response content: - '*/*': + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: text/html: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" parameters: - name: id in: path @@ -969,20 +969,20 @@ Describes a single API operation on a path. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | -| summary | `string` | A short summary of what the operation does. | -| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | -| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | -| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#path-item-parameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | -| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is fully supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as [GET](https://tools.ietf.org/html/rfc7231#section-4.3.1), [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)), `requestBody` is permitted but does not have well-defined semantics and SHOULD be avoided if possible. | -| responses | [Responses Object](#responses-object) | The list of possible responses as they are returned from executing this operation. | -| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. | -| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | -| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oas-security). To remove a top-level security declaration, an empty array can be used. | -| servers | [[Server Object](#server-object)] | An alternative `servers` array to service this operation. If a `servers` array is specified at the [Path Item Object](#path-item-servers) or [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | +| Field Name | Type | Description | +| -------------------------------------------------- | :-----------------------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. | +| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#path-item-parameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | +| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is fully supported in HTTP methods where the HTTP 1.1 specification [RFC7231](https://tools.ietf.org/html/rfc7231#section-4.3.1) has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as [GET](https://tools.ietf.org/html/rfc7231#section-4.3.1), [HEAD](https://tools.ietf.org/html/rfc7231#section-4.3.2) and [DELETE](https://tools.ietf.org/html/rfc7231#section-4.3.5)), `requestBody` is permitted but does not have well-defined semantics and SHOULD be avoided if possible. | +| responses | [Responses Object](#responses-object) | The list of possible responses as they are returned from executing this operation. | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. | +| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oas-security). To remove a top-level security declaration, an empty array can be used. | +| servers | [[Server Object](#server-object)] | An alternative `servers` array to service this operation. If a `servers` array is specified at the [Path Item Object](#path-item-servers) or [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1075,12 +1075,12 @@ requestBody: required: - status responses: - '200': + "200": description: Pet updated. content: application/json: {} application/xml: {} - '405': + "405": description: Method Not Allowed content: application/json: {} @@ -1097,10 +1097,10 @@ Allows referencing an external resource for extended documentation. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| -------------------------------------------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------- | | description | `string` | A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| url | `string` | **REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI. | +| url | `string` | **REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1130,10 +1130,10 @@ See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a detail There are four possible parameter locations specified by the `in` field: -* path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. -* header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. -* cookie - Used to pass a specific cookie value to the API. +- path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`. +- header - Custom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. +- cookie - Used to pass a specific cookie value to the API. ##### Fixed Fields @@ -1145,13 +1145,13 @@ See [Appendix B](#appendix-b-data-type-conversion) for a discussion of convertin These fields MAY be used with either `content` or `schema`. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameter-in) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#paths-path) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameter-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`](#parameter-in) field.
| -| in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. | -| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameter-in) is `"path"`, this field is **REQUIRED** and its value MUST be `true`. Otherwise, the field MAY be included and its default value is `false`. | -| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| Field Name | Type | Description | +| ---------------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case sensitive_.
  • If [`in`](#parameter-in) is `"path"`, the `name` field MUST correspond to a template expression occurring within the [path](#paths-path) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameter-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`](#parameter-in) field.
| +| in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"header"`, `"path"` or `"cookie"`. | +| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameter-in) is `"path"`, this field is **REQUIRED** and its value MUST be `true`. Otherwise, the field MAY be included and its default value is `false`. | +| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | | allowEmptyValue | `boolean` | If `true`, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is `false`. If [`style`](#parameter-style) is used, and if [behavior is _n/a_ (cannot be serialized)](#style-examples), the value of `allowEmptyValue` SHALL be ignored. Interactions between this field and the parameter's [Schema Object](#schema-object) are implementation-defined. This field is valid only for `query` parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1166,14 +1166,14 @@ The `example` and `examples` fields are mutually exclusive, and if either is pre Serializing with `schema` is NOT RECOMMENDED for `in: "cookie"` parameters, `in: "header"` parameters that use HTTP header parameters (name=value pairs following a `;`) in their values, or `in: "header"` parameters where values might have non-URL-safe characters; see [Appendix D](#appendix-d-serializing-headers-and-cookies) for details. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `"query"` - `"form"`; for `"path"` - `"simple"`; for `"header"` - `"simple"`; for `"cookie"` - `"form"`. | -| explode | `boolean` | 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 field has no effect. When [`style`](#parameter-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. | -| allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are [not allowed in the query string](https://datatracker.ietf.org/doc/html/rfc3986#section-3.4) (`[`, `]`, `#`), or have a special meaning in `application/x-www-form-urlencoded` (`-`, `&`, `+`); see Appendices [C](#appendix-c-using-rfc6570-based-serialization) and [E](#appendix-e-percent-encoding-and-form-media-types) for details. This field only applies to parameters with an `in` value of `query`. The default value is `false`. | -| schema | [Schema Object](#schema-object) | The schema defining the type used for the parameter. | -| example | Any | Example of the parameter's potential value; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value; see [Working With Examples](#working-with-examples). | +| Field Name | Type | Description | +| ---------------------------------------------------- | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `"query"` - `"form"`; for `"path"` - `"simple"`; for `"header"` - `"simple"`; for `"cookie"` - `"form"`. | +| explode | `boolean` | 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 field has no effect. When [`style`](#parameter-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. | +| allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are [not allowed in the query string](https://datatracker.ietf.org/doc/html/rfc3986#section-3.4) (`[`, `]`, `#`), or have a special meaning in `application/x-www-form-urlencoded` (`-`, `&`, `+`); see Appendices [C](#appendix-c-using-rfc6570-based-serialization) and [E](#appendix-e-percent-encoding-and-form-media-types) for details. This field only applies to parameters with an `in` value of `query`. The default value is `false`. | +| schema | [Schema Object](#schema-object) | The schema defining the type used for the parameter. | +| example | Any | Example of the parameter's potential value; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value; see [Working With Examples](#working-with-examples). | See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc6570-based-serialization) for additional guidance. @@ -1182,23 +1182,23 @@ See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc65 For more complex scenarios, the [`content`](#parameter-content) field can define the media type and schema of the parameter, as well as give examples of its use. Using `content` with a `text/plain` media type is RECOMMENDED for `in: "header"` and `in: "cookie"` parameters where the `schema` strategy is not appropriate. -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| --------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | | content | Map[`string`, [Media Type Object](#media-type-object)] | 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. | ##### Style Values In order to support common ways of serializing simple parameters, a set of `style` values are defined. -| `style` | [`type`](#data-types) | `in` | Comments | -| ---- | ---- | ---- | ---- | -| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | -| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | -| simple | `primitive`, `array`, `object` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | -| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | -| spaceDelimited | `array`, `object` | `query` | Space separated array values or object properties and values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | -| pipeDelimited | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | -| deepObject | `object` | `query` | Allows objects with scalar properties to be represented using form parameters. The representation of array or object properties is not defined. | +| `style` | [`type`](#data-types) | `in` | Comments | +| -------------- | ------------------------------ | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| matrix | `primitive`, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| label | `primitive`, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| simple | `primitive`, `array`, `object` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| form | `primitive`, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| spaceDelimited | `array`, `object` | `query` | Space separated array values or object properties and values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| pipeDelimited | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| deepObject | `object` | `query` | Allows objects with scalar properties to be represented using form parameters. The representation of array or object properties is not defined. | See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a discussion of percent-encoding, including when delimiters need to be percent-encoded and options for handling collisions with percent-encoded data. @@ -1214,29 +1214,29 @@ Assume a parameter named `color` has one of the following values: The following table shows examples, as would be shown with the `example` or `examples` keywords, of the different serializations for each value. -* The value _empty_ denotes the empty string, and is unrelated to the `allowEmptyValue` field -* The behavior of combinations marked _n/a_ is undefined -* The `undefined` column replaces the `empty` column in previous versions of this specification in order to better align with [RFC6570](https://www.rfc-editor.org/rfc/rfc6570.html#section-2.3) terminology, which describes certain values including but not limited to `null` as "undefined" values with special handling; notably, the empty string is _not_ undefined -* For `form` and the non-RFC6570 query string styles `spaceDelimited`, `pipeDelimited`, and `deepObject`, each example is shown prefixed with `?` as if it were the only query parameter; see [Appendix C](#appendix-c-using-rfc6570-based-serialization) for more information on constructing query strings from multiple parameters, and [Appendix D](#appendix-d-serializing-headers-and-cookies) for warnings regarding `form` and cookie parameters -* Note that the `?` prefix is not appropriate for serializing `application/x-www-form-urlencoded` HTTP message bodies, and MUST be stripped or (if constructing the string manually) not added when used in that context; see the [Encoding Object](#encoding-object) for more information -* The examples are percent-encoded as required by RFC6570 and RFC3986; see [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a thorough discussion of percent-encoding concerns, including why unencoded `|` (`%7C`), `[` (`%5B`), and `]` (`%5D`) seem to work in some environments despite not being compliant. +- The value _empty_ denotes the empty string, and is unrelated to the `allowEmptyValue` field +- The behavior of combinations marked _n/a_ is undefined +- The `undefined` column replaces the `empty` column in previous versions of this specification in order to better align with [RFC6570](https://www.rfc-editor.org/rfc/rfc6570.html#section-2.3) terminology, which describes certain values including but not limited to `null` as "undefined" values with special handling; notably, the empty string is _not_ undefined +- For `form` and the non-RFC6570 query string styles `spaceDelimited`, `pipeDelimited`, and `deepObject`, each example is shown prefixed with `?` as if it were the only query parameter; see [Appendix C](#appendix-c-using-rfc6570-based-serialization) for more information on constructing query strings from multiple parameters, and [Appendix D](#appendix-d-serializing-headers-and-cookies) for warnings regarding `form` and cookie parameters +- Note that the `?` prefix is not appropriate for serializing `application/x-www-form-urlencoded` HTTP message bodies, and MUST be stripped or (if constructing the string manually) not added when used in that context; see the [Encoding Object](#encoding-object) for more information +- The examples are percent-encoded as required by RFC6570 and RFC3986; see [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a thorough discussion of percent-encoding concerns, including why unencoded `|` (`%7C`), `[` (`%5B`), and `]` (`%5D`) seem to work in some environments despite not being compliant. -| [`style`](#style-values) | `explode` | `undefined` | `string` | `array` | `object` | -| ---- | ---- | ---- | ---- | ---- | ---- | -| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | -| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | -| label | false | . | .blue | .blue,black,brown | .R,100,G,200,B,150 | -| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | -| simple | false | _empty_ | blue | blue,black,brown | R,100,G,200,B,150 | -| simple | true | _empty_ | blue | blue,black,brown | R=100,G=200,B=150 | -| form | false | ?color= | ?color=blue | ?color=blue,black,brown | ?color=R,100,G,200,B,150 | -| form | true | ?color= | ?color=blue | ?color=blue&color=black&color=brown | ?R=100&G=200&B=150 | -| spaceDelimited | false | _n/a_ | _n/a_ | ?color=blue%20black%20brown | ?color=R%20100%20G%20200%20B%20150 | -| spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| pipeDelimited | false | _n/a_ | _n/a_ | ?color=blue%7Cblack%7Cbrown | ?color=R%7C100%7CG%7C200%7CB%7C150 | -| pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| deepObject | false | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| deepObject | true | _n/a_ | _n/a_ | _n/a_ | ?color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150 | +| [`style`](#style-values) | `explode` | `undefined` | `string` | `array` | `object` | +| ------------------------ | --------- | ------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue,black,brown | .R,100,G,200,B,150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| simple | false | _empty_ | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | _empty_ | blue | blue,black,brown | R=100,G=200,B=150 | +| form | false | ?color= | ?color=blue | ?color=blue,black,brown | ?color=R,100,G,200,B,150 | +| form | true | ?color= | ?color=blue | ?color=blue&color=black&color=brown | ?R=100&G=200&B=150 | +| spaceDelimited | false | _n/a_ | _n/a_ | ?color=blue%20black%20brown | ?color=R%20100%20G%20200%20B%20150 | +| spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | +| pipeDelimited | false | _n/a_ | _n/a_ | ?color=blue%7Cblack%7Cbrown | ?color=R%7C100%7CG%7C200%7CB%7C150 | +| pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | +| deepObject | false | _n/a_ | _n/a_ | _n/a_ | _n/a_ | +| deepObject | true | _n/a_ | _n/a_ | _n/a_ | ?color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150 | ##### Parameter Object Examples @@ -1401,11 +1401,11 @@ Describes a single request body. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | +| Field Name | Type | Description | +| -------------------------------------------------- | :----------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) 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 | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1464,14 +1464,14 @@ description: user to add to the system content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User example externalValue: https://foo.bar/examples/user-example.json application/xml: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User example in XML @@ -1481,7 +1481,7 @@ content: user: summary: User example in plain text externalValue: https://foo.bar/examples/user-example.txt - '*/*': + "*/*": examples: user: summary: User example in other format @@ -1498,12 +1498,12 @@ See [Working With Examples](#working-with-examples) for further guidance regardi ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| schema | [Schema Object](#schema-object) | The schema defining the content of the request, response, parameter, or header. | -| example | Any | Example of the media type; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type; see [Working With Examples](#working-with-examples). | -| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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` field SHALL only apply to [Request Body Objects](#request-body-object), and only when the media type is `multipart` or `application/x-www-form-urlencoded`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. | +| Field Name | Type | Description | +| ------------------------------------------ | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) | The schema defining the content of the request, response, parameter, or header. | +| example | Any | Example of the media type; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type; see [Working With Examples](#working-with-examples). | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | 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` field SHALL only apply to [Request Body Objects](#request-body-object), and only when the media type is `multipart` or `application/x-www-form-urlencoded`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1547,7 +1547,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten ```yaml application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" examples: cat: summary: An example of a cat @@ -1566,7 +1566,7 @@ application/json: gender: Female breed: Mixed frog: - $ref: '#/components/examples/frog-example' + $ref: "#/components/examples/frog-example" ``` ##### Considerations for File Uploads @@ -1644,23 +1644,23 @@ See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a detail These fields MAY be used either with or without the RFC6570-style serialization fields defined in the next section below. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| contentType | `string` | The `Content-Type` for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. `image/png`) or a wildcard media type (e.g. `image/*`). Default value depends on the property type as shown in the table below. | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers. `Content-Type` is described separately and SHALL be ignored in this section. This field SHALL be ignored if the request body media type is not a `multipart`. | +| Field Name | Type | Description | +| ----------------------------------------------- | :-------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | The `Content-Type` for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. `image/png`) or a wildcard media type (e.g. `image/*`). Default value depends on the property type as shown in the table below. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers. `Content-Type` is described separately and SHALL be ignored in this section. This field SHALL be ignored if the request body media type is not a `multipart`. | This object MAY be extended with [Specification Extensions](#specification-extensions). The default values for `contentType` are as follows, where an _n/a_ in the `contentEncoding` column means that the presence or value of `contentEncoding` is irrelevant: -| `type` | `contentEncoding` | Default `contentType` | -| ---- | ---- | ---- | -| [_absent_](#working-with-binary-data) | _n/a_ | `application/octet-stream` | -| `string` | _present_ | `application/octet-stream` | -| `string` | _absent_ | `text/plain` | -| `number`, `integer`, or `boolean` | _n/a_ | `text/plain` | -| `object` | _n/a_ | `application/json` | -| `array` | _n/a_ | according to the `type` of the `items` schema | +| `type` | `contentEncoding` | Default `contentType` | +| ------------------------------------- | ----------------- | --------------------------------------------- | +| [_absent_](#working-with-binary-data) | _n/a_ | `application/octet-stream` | +| `string` | _present_ | `application/octet-stream` | +| `string` | _absent_ | `text/plain` | +| `number`, `integer`, or `boolean` | _n/a_ | `text/plain` | +| `object` | _n/a_ | `application/json` | +| `array` | _n/a_ | according to the `type` of the `items` schema | Determining how to handle a `type` value of `null` depends on how `null` values are being serialized. If `null` values are entirely omitted, then the `contentType` is irrelevant. @@ -1668,10 +1668,10 @@ See [Appendix B](#appendix-b-data-type-conversion) for a discussion of data type ###### Fixed Fields for RFC6570-style Serialization -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameter-style) field. The behavior follows the same values as `query` parameters, including default values. Note that the initial `?` used in query strings is not used in `application/x-www-form-urlencoded` message bodies, and MUST be removed (if using an RFC6570 implementation) or simply not added (if constructing the string manually). This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | -| explode | `boolean` | When this is true, property 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 properties this field has no effect. When [`style`](#encoding-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | +| Field Name | Type | Description | +| --------------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameter-style) field. The behavior follows the same values as `query` parameters, including default values. Note that the initial `?` used in query strings is not used in `application/x-www-form-urlencoded` message bodies, and MUST be removed (if using an RFC6570 implementation) or simply not added (if constructing the string manually). This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | +| explode | `boolean` | When this is true, property 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 properties this field has no effect. When [`style`](#encoding-style) is `"form"`, the default value is `true`. For all other styles, the default value is `false`. Note that despite `false` being the default for `deepObject`, the combination of `false` with `deepObject` is undefined. This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | | allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are [not allowed in the query string](https://datatracker.ietf.org/doc/html/rfc3986#section-3.4) (`[`, `]`, `#`), or have a special meaning in `application/x-www-form-urlencoded` (`-`, `&`, `+`); see Appendices [C](#appendix-c-using-rfc6570-based-serialization) and [E](#appendix-e-percent-encoding-and-form-media-types) for details. The default value is `false`. This field SHALL be ignored if the request body media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | See also [Appendix C: Using RFC6570 Implementations](#appendix-c-using-rfc6570-based-serialization) for additional guidance, including on difficulties caused by the interaction between RFC6570's percent-encoding rules and the `multipart/form-data` media type. @@ -1813,7 +1813,7 @@ requestBody: # subschema, which is an object, so `application/json` type: array items: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" ``` ###### Example: Multipart Form with Encoding Objects @@ -1839,7 +1839,7 @@ requestBody: description: addresses in XML format type: array items: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" profileImage: # default is application/octet-stream, but we can declare # a more specific image type or types @@ -1896,14 +1896,14 @@ call. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| --------------------------------------- | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------- | | default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. | ##### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ------------------------------------------------------------------- | :--------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `200` and `299`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1938,18 +1938,18 @@ A 200 response for a successful operation and a default response for others (imp ``` ```yaml -'200': +"200": description: a pet to be returned content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: Unexpected error content: application/json: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` #### Response Object @@ -1959,12 +1959,12 @@ Describes a single response from an API operation, including design-time, static ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| description | `string` | **REQUIRED**. A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | -| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` | -| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | +| Field Name | Type | Description | +| ---------------------------------------------- | :-------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| description | `string` | **REQUIRED**. A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC7230](https://tools.ietf.org/html/rfc7230#section-3.2) states header names are case insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1995,7 +1995,7 @@ content: schema: type: array items: - $ref: '#/components/schemas/VeryComplexType' + $ref: "#/components/schemas/VeryComplexType" ``` Response with a string type: @@ -2063,7 +2063,7 @@ content: text/plain: schema: type: string - example: 'whoa!' + example: "whoa!" headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period @@ -2101,8 +2101,8 @@ To describe incoming requests from the API provider independent from another API ##### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ---------------------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | {expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](https://learn.openapis.org/examples/v3.0/callback-example.html) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2141,16 +2141,16 @@ Location: https://example.org/subscription/1 The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. -| Expression | Value | -| ---- | :---- | -| $url | | -| $method | POST | -| $request.path.eventType | myevent | -| $request.query.queryUrl | | -| $request.header.content-type | application/json | -| $request.body#/failedUrl | | -| $request.body#/successUrls/1 | | -| $response.header.Location | | +| Expression | Value | +| ---------------------------- | :------------------------------------------------------------------------------------- | +| $url | | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | | +| $request.header.content-type | application/json | +| $request.body#/failedUrl | | +| $request.body#/successUrls/1 | | +| $response.header.Location | | ##### Callback Object Examples @@ -2158,16 +2158,16 @@ The following example uses the user provided `queryUrl` query string parameter t ```yaml myCallback: - '{$request.query.queryUrl}': + "{$request.query.queryUrl}": post: requestBody: description: Callback payload content: application/json: schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` @@ -2175,16 +2175,16 @@ The following example shows a callback where the server is hard-coded, but the q ```yaml transactionCallback: - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + "http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}": post: requestBody: description: Callback payload content: application/json: schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` @@ -2197,11 +2197,11 @@ Examples allow demonstration of the usage of properties, parameters and objects ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| summary | `string` | Short description for the example. | -| description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | +| Field Name | Type | Description | +| -------------------------------------------------- | :------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | Short description for the example. | +| description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| value | Any | Embedded literal example. The `value` field and `externalValue` field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary. | | externalValue | `string` | A URI that identifies 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. See the rules for resolving [Relative References](#relative-references-in-api-description-uris). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2236,9 +2236,9 @@ In a request body: ```yaml requestBody: content: - 'application/json': + "application/json": schema: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" examples: foo: summary: A foo example @@ -2271,22 +2271,22 @@ parameters: format: zip-code examples: zip-example: - $ref: '#/components/examples/zip-example' + $ref: "#/components/examples/zip-example" ``` In a response: ```yaml responses: - '200': + "200": description: your car appointment has been booked content: application/json: schema: - $ref: '#/components/schemas/SuccessResponse' + $ref: "#/components/schemas/SuccessResponse" examples: confirmation-success: - $ref: '#/components/examples/confirmation-success' + $ref: "#/components/examples/confirmation-success" ``` Two different uses of JSON strings: @@ -2374,14 +2374,14 @@ For computing links and providing instructions to execute them, a [runtime expre ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| operationRef | `string` | A URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI Description. | -| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | -| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. `path.id` for an `id` parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. | -| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | -| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| server | [Server Object](#server-object) | A server object to be used by the target operation. | +| Field Name | Type | Description | +| --------------------------------------------- | :--------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| operationRef | `string` | A URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI Description. | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. `path.id` for an `id` parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. | +| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#server-object) | A server object to be used by the target operation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2410,7 +2410,7 @@ paths: type: string get: responses: - '200': + "200": description: the user being returned content: application/json: @@ -2440,7 +2440,7 @@ paths: get: operationId: getUserAddress responses: - '200': + "200": description: the user's address ``` @@ -2470,7 +2470,7 @@ field in an [Operation Object](#operation-object)), references MAY also be made links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: '#/paths/~12.0~1repositories~1%7Busername%7D/get' + operationRef: "#/paths/~12.0~1repositories~1%7Busername%7D/get" parameters: username: $response.body#/username ``` @@ -2523,15 +2523,15 @@ The table below provides examples of runtime expressions and examples of their u ##### Examples -| Source Location | example expression | notes | -| ---- | :---- | :---- | -| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | -| Requested media type | `$request.header.accept` | | -| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | -| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | -| Request URL | `$url` | | -| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | -| Response header | `$response.header.Server` | Single header values only are available | +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | Runtime expressions preserve the type of the referenced value. Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. @@ -2552,11 +2552,11 @@ The Header Object follows the structure of the [Parameter Object](#parameter-obj These fields MAY be used with either `content` or `schema`. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| description | `string` | A brief description of the header. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| required | `boolean` | Determines whether this header is mandatory. The default value is `false`. | -| deprecated | `boolean` | Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| Field Name | Type | Description | +| -------------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| description | `string` | A brief description of the header. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this header is mandatory. The default value is `false`. | +| deprecated | `boolean` | Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2570,13 +2570,13 @@ Serializing with `schema` is NOT RECOMMENDED for headers with parameters (name=v When `example` or `examples` are provided in conjunction with the `schema` field, the example SHOULD match the specified schema and follow the prescribed serialization strategy for the header. The `example` and `examples` fields are mutually exclusive, and if either is present it SHALL _override_ any `example` in the schema. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how the header value will be serialized. The default (and only legal value for headers) is `"simple"`. | -| explode | `boolean` | When this is true, header values of type `array` or `object` generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see [Style Examples](#style-examples). For other data types this field has no effect. The default value is `false`. | -| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the header. | -| example | Any | Example of the header's potential value; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the header's potential value; see [Working With Examples](#working-with-examples). | +| Field Name | Type | Description | +| -------------------------------------- | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the header value will be serialized. The default (and only legal value for headers) is `"simple"`. | +| explode | `boolean` | When this is true, header values of type `array` or `object` generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see [Style Examples](#style-examples). For other data types this field has no effect. The default value is `false`. | +| schema | [Schema Object](#schema-object) \| [Reference Object](#reference-object) | The schema defining the type used for the header. | +| example | Any | Example of the header's potential value; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the header's potential value; see [Working With Examples](#working-with-examples). | See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc6570-based-serialization) for additional guidance. @@ -2585,8 +2585,8 @@ See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc65 For more complex scenarios, the [`content`](#header-content) field can define the media type and schema of the header, as well as give examples of its use. Using `content` with a `text/plain` media type is RECOMMENDED for headers where the `schema` strategy is not appropriate. -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| ------------------------------------ | :----------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------- | | content | Map[`string`, [Media Type Object](#media-type-object)] | A map containing the representations for the header. The key is the media type and the value describes it. The map MUST only contain one entry. | ##### Header Object Example @@ -2642,11 +2642,11 @@ It is not mandatory to have a Tag Object per tag defined in the Operation Object ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The name of the tag. | -| description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | +| Field Name | Type | Description | +| -------------------------------------------- | :-------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the tag. | +| description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2674,10 +2674,10 @@ See the rules for resolving [Relative References](#relative-references-in-api-de ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| $ref | `string` | **REQUIRED**. The reference identifier. This MUST be in the form of a URI. | -| summary | `string` | A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. | +| Field Name | Type | Description | +| ----------------------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | **REQUIRED**. The reference identifier. This MUST be in the form of a URI. | +| summary | `string` | A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. | | description | `string` | A description which by default SHOULD override that of the referenced component. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. | This object cannot be extended with additional properties, and any properties added SHALL be ignored. @@ -2693,7 +2693,7 @@ Note that this restriction on additional properties is a difference between Refe ``` ```yaml -$ref: '#/components/schemas/Pet' +$ref: "#/components/schemas/Pet" ``` ##### Relative Schema Document Example @@ -2738,8 +2738,8 @@ The OpenAPI Schema Object dialect for this version of the specification is ident The following keywords are taken from the JSON Schema specification but their definitions have been extended by the OAS: -* description - [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -* format - See [Data Type Formats](#data-type-format) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats. +- description - [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. +- format - See [Data Type Formats](#data-type-format) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats. In addition to the JSON Schema keywords comprising the OAS dialect, the Schema Object supports keywords from any other vocabularies, or entirely arbitrary properties. @@ -2748,12 +2748,12 @@ JSON Schema implementations MAY choose to treat keywords defined by the OpenAPI ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| discriminator | [Discriminator Object](#discriminator-object) | Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See [Composition and Inheritance](#composition-and-inheritance-polymorphism) for more details. | -| xml | [XML Object](#xml-object) | This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | -| example | Any | A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.

**Deprecated:** The `example` field has been deprecated in favor of the JSON Schema `examples` keyword. Use of `example` is discouraged, and later versions of this specification may remove it. | +| Field Name | Type | Description | +| ------------------------------------------------ | :-------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| discriminator | [Discriminator Object](#discriminator-object) | Adds support for polymorphism. The discriminator is used to determine which of a set of schemas a payload is expected to satisfy. See [Composition and Inheritance](#composition-and-inheritance-polymorphism) for more details. | +| xml | [XML Object](#xml-object) | This MAY be used only on property schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.

**Deprecated:** The `example` field has been deprecated in favor of the JSON Schema `examples` keyword. Use of `example` is discouraged, and later versions of this specification may remove it. | This object MAY be extended with [Specification Extensions](#specification-extensions), though as noted, additional properties MAY omit the `x-` prefix within this object. @@ -2793,15 +2793,15 @@ When used, the `discriminator` indicates the name of the property that hints whi As such, the `discriminator` field MUST be a required field. There are two ways to define the value of a discriminator for an inheriting instance. -* Use the schema name. -* [Override the schema name](#discriminator-mapping) by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. +- Use the schema name. +- [Override the schema name](#discriminator-mapping) by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. ###### Generic (Template) Data Structures Implementations MAY support defining generic or template data structures using JSON Schema's dynamic referencing feature: -* `$dynamicAnchor` identifies a set of possible schemas (including a default placeholder schema) to which a `$dynamicRef` can resolve -* `$dynamicRef` resolves to the first matching `$dynamicAnchor` encountered on its path from the schema entry point to the reference, as described in the JSON Schema specification +- `$dynamicAnchor` identifies a set of possible schemas (including a default placeholder schema) to which a `$dynamicRef` can resolve +- `$dynamicRef` resolves to the first matching `$dynamicAnchor` encountered on its path from the schema entry point to the reference, as described in the JSON Schema specification An example is included in the "Schema Object Examples" section below, and further information can be found on the Learn OpenAPI site's ["Dynamic References"](https://learn.openapis.org/referencing/dynamic.html) page. @@ -2873,7 +2873,7 @@ properties: name: type: string address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" age: type: integer format: int32 @@ -2913,7 +2913,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/components/schemas/ComplexModel' + $ref: "#/components/schemas/ComplexModel" ``` ###### Model with Annotated Enumeration @@ -3042,7 +3042,7 @@ components: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/components/schemas/ErrorModel' + - $ref: "#/components/schemas/ErrorModel" - type: object required: - rootCause @@ -3136,7 +3136,7 @@ components: Cat: # "Cat" will be used as the discriminating value description: A representation of a cat allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object properties: huntingSkill: @@ -3152,7 +3152,7 @@ components: Dog: # "Dog" will be used as the discriminating value description: A representation of a dog allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object properties: packSize: @@ -3288,10 +3288,10 @@ Note that `discriminator` MUST NOT change the validation outcome of the schema. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminating value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined. | -| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or URI references. | +| Field Name | Type | Description | +| -------------------------------------------- | :---------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| propertyName | `string` | **REQUIRED**. The name of the property in the payload that will hold the discriminating value. This property SHOULD be required in the payload schema, as the behavior when the property is absent is undefined. | +| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or URI references. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3328,9 +3328,9 @@ In OAS 3.x, a response payload MAY be described to be exactly one of any number ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" ``` which means the payload _MUST_, by validation, match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. Deserialization of a `oneOf` can be a costly operation, as it requires determining which schema matches the payload and thus should be used in deserialization. This problem also exists for `anyOf` schemas. A `discriminator` MAY be used as a "hint" to improve the efficiency of selection of the matching schema. The `discriminator` field cannot change the validation result of the `oneOf`, it can only help make the deserialization more efficient and provide better error messaging. We can specify the exact field that tells us which schema is expected to match the instance: @@ -3338,9 +3338,9 @@ which means the payload _MUST_, by validation, match exactly one of the schemas ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" discriminator: propertyName: petType ``` @@ -3361,14 +3361,14 @@ In scenarios where the value of the `discriminator` field does not match the sch ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" - $ref: https://gigantic-server.com/schemas/Monster/schema.json discriminator: propertyName: petType mapping: - dog: '#/components/schemas/Dog' + dog: "#/components/schemas/Dog" monster: https://gigantic-server.com/schemas/Monster/schema.json ``` @@ -3394,7 +3394,7 @@ components: dog: Dog Cat: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Cat` properties: @@ -3402,7 +3402,7 @@ components: type: string Dog: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Dog` properties: @@ -3410,7 +3410,7 @@ components: type: string Lizard: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Lizard` properties: @@ -3447,21 +3447,21 @@ See examples for expected behavior. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `"array"` (outside the `items`), it will affect the wrapping element if and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | -| namespace | `string` | The URI of the namespace definition. Value MUST be in the form of a non-relative URI. | -| prefix | `string` | The prefix to be used for the [name](#xml-name). | -| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | -| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `"array"` (outside the `items`). | +| Field Name | Type | Description | +| ------------------------------------- | :-------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | Replaces the name of the element/attribute used for the described schema property. When defined within `items`, it will affect the name of the individual XML elements within the list. When defined alongside `type` being `"array"` (outside the `items`), it will affect the wrapping element if and only if `wrapped` is `true`. If `wrapped` is `false`, it will be ignored. | +| namespace | `string` | The URI of the namespace definition. Value MUST be in the form of a non-relative URI. | +| prefix | `string` | The prefix to be used for the [name](#xml-name). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `"array"` (outside the `items`). | This object MAY be extended with [Specification Extensions](#specification-extensions). The `namespace` field is intended to match the syntax of [XML namespaces](https://www.w3.org/TR/xml-names11/), although there are a few caveats: -* Versions 3.1.0, 3.0.3, and earlier of this specification erroneously used the term "absolute URI" instead of "non-relative URI", so authors using namespaces that include a fragment should check tooling support carefully. -* XML allows but discourages relative URI-references, while this specification outright forbids them. -* XML 1.1 allows IRIs ([RFC3987](https://datatracker.ietf.org/doc/html/rfc3987)) as namespaces, and specifies that namespaces are compared without any encoding or decoding, which means that IRIs encoded to meet this specification's URI syntax requirement cannot be compared to IRIs as-is. +- Versions 3.1.0, 3.0.3, and earlier of this specification erroneously used the term "absolute URI" instead of "non-relative URI", so authors using namespaces that include a fragment should check tooling support carefully. +- XML allows but discourages relative URI-references, while this specification outright forbids them. +- XML 1.1 allows IRIs ([RFC3987](https://datatracker.ietf.org/doc/html/rfc3987)) as namespaces, and specifies that namespaces are compared without any encoding or decoding, which means that IRIs encoded to meet this specification's URI syntax requirement cannot be compared to IRIs as-is. ##### XML Object Examples @@ -3807,16 +3807,16 @@ Please note that as of 2020, the implicit flow is about to be deprecated by [OAu ##### Fixed Fields -| Field Name | Type | Applies To | Description | -| ---- | :----: | ---- | ---- | -| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"mutualTLS"`, `"oauth2"`, `"openIdConnect"`. | -| description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | -| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"`, or `"cookie"`. | -| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authentication scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). The value is case-insensitive, as defined in [RFC7235](https://datatracker.ietf.org/doc/html/rfc7235#section-2.1). | -| bearerFormat | `string` | `http` (`"bearer"`) | 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. | -| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | -| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. [Well-known URL](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) to discover the [[OpenID-Connect-Discovery]] [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------------ | :---------------------------------------: | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"mutualTLS"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"`, or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authentication scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). The value is case-insensitive, as defined in [RFC7235](https://datatracker.ietf.org/doc/html/rfc7235#section-2.1). | +| bearerFormat | `string` | `http` (`"bearer"`) | 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. | +| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. [Well-known URL](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) to discover the [[OpenID-Connect-Discovery]] [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3915,12 +3915,12 @@ Allows configuration of the supported OAuth Flows. ##### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | -| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | +| Field Name | Type | Description | +| -------------------------------------------------------------- | :-------------------------------------: | ---------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | | clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | -| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3930,12 +3930,12 @@ Configuration details for a supported OAuth Flow ##### Fixed Fields -| Field Name | Type | Applies To | Description | -| ---- | :----: | ---- | ---- | -| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | +| Field Name | Type | Applies To | Description | +| ----------------------------------------------------------- | :---------------------: | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3995,8 +3995,8 @@ An empty Security Requirement Object (`{}`) indicates anonymous access is suppor ##### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ----------------------------------------------- | :--------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | {name} | [`string`] | Each name MUST correspond to a security scheme which is declared in the [Security Schemes](#security-scheme-object) under the [Components Object](#components-object). If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. | ##### Security Requirement Object Examples @@ -4058,9 +4058,9 @@ While the OpenAPI Specification tries to accommodate most use cases, additional The extensions properties are implemented as patterned fields that are always prefixed by `x-`. -| Field Pattern | Type | Description | -| ---- | :--: | ---- | -| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. Field names beginning `x-oai-` and `x-oas-` are reserved for uses defined by the [OpenAPI Initiative](https://www.openapis.org/). The value can be any valid JSON value (`null`, a primitive, an array, or an object.) | +| Field Pattern | Type | Description | +| -------------------------------------- | :--: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. Field names beginning `x-oai-` and `x-oas-` are reserved for uses defined by the [OpenAPI Initiative](https://www.openapis.org/). The value can be any valid JSON value (`null`, a primitive, an array, or an object.) | The OpenAPI Initiative maintains several [[OpenAPI-Registry|extension registries]], including registries for [individual extension keywords](https://spec.openapis.org/registry/extension/) and [extension keyword namespaces](https://spec.openapis.org/registry/namespace/). @@ -4087,10 +4087,10 @@ Two examples of this: OpenAPI Descriptions use a combination of JSON, YAML, and JSON Schema, and therefore share their security considerations: -* [JSON](https://www.iana.org/assignments/media-types/application/json) -* [YAML](https://www.iana.org/assignments/media-types/application/yaml) -* [JSON Schema Core](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-13) -* [JSON Schema Validation](https://tools.ietf.org/html/draft-bhutton-json-schema-validation-00#section-10) +- [JSON](https://www.iana.org/assignments/media-types/application/json) +- [YAML](https://www.iana.org/assignments/media-types/application/yaml) +- [JSON Schema Core](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-13) +- [JSON Schema Validation](https://tools.ietf.org/html/draft-bhutton-json-schema-validation-00#section-10) ### Tooling and Usage Scenarios @@ -4114,25 +4114,25 @@ Certain fields allow the use of Markdown which can contain HTML including script ## Appendix A: Revision History -| Version | Date | Notes | -| ---- | ---- | ---- | -| 3.1.1 | 2024-10-24 | Patch release of the OpenAPI Specification 3.1.1 | -| 3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0 | -| 3.1.0-rc1 | 2020-10-08 | rc1 of the 3.1 specification | -| 3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification | -| 3.0.4 | 2024-10-24 | Patch release of the OpenAPI Specification 3.0.4 | -| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | -| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | -| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | -| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | -| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | -| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | -| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | -| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | -| 2.0 | 2014-09-08 | Release of Swagger 2.0 | -| 1.2 | 2014-03-14 | Initial release of the formal document. | -| 1.1 | 2012-08-22 | Release of Swagger 1.1 | -| 1.0 | 2011-08-10 | First release of the Swagger Specification | +| Version | Date | Notes | +| --------- | ---------- | ------------------------------------------------- | +| 3.1.1 | 2024-10-24 | Patch release of the OpenAPI Specification 3.1.1 | +| 3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0 | +| 3.1.0-rc1 | 2020-10-08 | rc1 of the 3.1 specification | +| 3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification | +| 3.0.4 | 2024-10-24 | Patch release of the OpenAPI Specification 3.0.4 | +| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | +| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | +| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | ## Appendix B: Data Type Conversion @@ -4147,8 +4147,8 @@ However, there is no general-purpose specification for converting schema-validat Two cases do offer standards-based guidance: -* [RFC3987](https://datatracker.ietf.org/doc/html/rfc3987#section-3.1) provides guidance for converting non-Unicode strings to UTF-8, particularly in the context of URIs (and by extension, the form media types which use the same encoding rules) -* [RFC6570](https://www.rfc-editor.org/rfc/rfc6570#section-2.3) specifies which values, including but not limited to `null`, are considered _undefined_ and therefore treated specially in the expansion process when serializing based on that specification +- [RFC3987](https://datatracker.ietf.org/doc/html/rfc3987#section-3.1) provides guidance for converting non-Unicode strings to UTF-8, particularly in the context of URIs (and by extension, the form media types which use the same encoding rules) +- [RFC6570](https://www.rfc-editor.org/rfc/rfc6570#section-2.3) specifies which values, including but not limited to `null`, are considered _undefined_ and therefore treated specially in the expansion process when serializing based on that specification Implementations of RFC6570 often have their own conventions for converting non-string values, but these are implementation-specific and not defined by the RFC itself. This is one reason for the OpenAPI Specification to leave these conversions as implementation-defined: It allows using RFC6570 implementations regardless of how they choose to perform the conversions. @@ -4166,11 +4166,11 @@ Requiring input as pre-formatted, schema-validated strings also improves round-t Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in three scenarios: -| Object | Condition | -| ---- | ---- | -| [Parameter Object](#parameter-object) | When `schema` is present | -| [Header Object](#header-object) | When `schema` is present | -| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used | +| Object | Condition | +| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| [Parameter Object](#parameter-object) | When `schema` is present | +| [Header Object](#header-object) | When `schema` is present | +| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used | Implementations of this specification MAY use an implementation of RFC6570 to perform variable expansion, however, some caveats apply. @@ -4187,16 +4187,16 @@ Using an implementation with a lower level of support will require additional ma Certain field values translate to RFC6570 [operators](https://datatracker.ietf.org/doc/html/rfc6570#section-2.2) (or lack thereof): -| field | value | equivalent | -| ---- | ---- | ---- | -| style | `"simple"` | _n/a_ | -| style | `"matrix"` | `;` prefix operator | -| style | `"label"` | `.` prefix operator | -| style | `"form"` | `?` prefix operator | -| allowReserved | `false` | _n/a_ | -| allowReserved | `true` | `+` prefix operator | -| explode | `false` | _n/a_ | -| explode | `true` | `*` modifier suffix | +| field | value | equivalent | +| ------------- | ---------- | ------------------- | +| style | `"simple"` | _n/a_ | +| style | `"matrix"` | `;` prefix operator | +| style | `"label"` | `.` prefix operator | +| style | `"form"` | `?` prefix operator | +| allowReserved | `false` | _n/a_ | +| allowReserved | `true` | `+` prefix operator | +| explode | `false` | _n/a_ | +| explode | `true` | `*` modifier suffix | Multiple `style: "form"` parameters are equivalent to a single RFC6570 [variable list](https://www.rfc-editor.org/rfc/rfc6570#section-2.2) using the `?` prefix operator: @@ -4234,9 +4234,9 @@ Implementations MAY create a properly delimited URI Template with variables for This includes: -* the styles `pipeDelimited`, `spaceDelimited`, and `deepObject`, which have no equivalents at all -* the combination of the style `form` with `allowReserved: true`, which is not allowed because only one prefix operator can be used at a time -* any parameter name that is not a legal RFC6570 variable name +- the styles `pipeDelimited`, `spaceDelimited`, and `deepObject`, which have no equivalents at all +- the combination of the style `form` with `allowReserved: true`, which is not allowed because only one prefix operator can be used at a time +- any parameter name that is not a legal RFC6570 variable name The Parameter Object's `name` field has a much more permissive syntax than RFC6570 [variable name syntax](https://www.rfc-editor.org/rfc/rfc6570#section-2.3). A parameter name that includes characters outside of the allowed RFC6570 variable character set MUST be percent-encoded before it can be used in a URI Template. @@ -4447,9 +4447,9 @@ _**NOTE:** In this section, the `application/x-www-form-urlencoded` and `multipa Percent-encoding is used in URIs and media types that derive their syntax from URIs. This process is concerned with three sets of characters, the names of which vary among specifications but are defined as follows for the purposes of this section: -* _unreserved_ characters do not need to be percent-encoded; while it is safe to percent-encode them, doing so produces a URI that is [not normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.2) -* _reserved_ characters either have special behavior in the URI syntax (such as delimiting components) or are reserved for other specifications that need to define special behavior (e.g. `form-urlencoded` defines special behavior for `=`, `&`, and `+`) -* _unsafe_ characters are known to cause problems when parsing URIs in certain environments +- _unreserved_ characters do not need to be percent-encoded; while it is safe to percent-encode them, doing so produces a URI that is [not normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.2) +- _reserved_ characters either have special behavior in the URI syntax (such as delimiting components) or are reserved for other specifications that need to define special behavior (e.g. `form-urlencoded` defines special behavior for `=`, `&`, and `+`) +- _unsafe_ characters are known to cause problems when parsing URIs in certain environments Unless otherwise specified, this section uses RFC3986's definition of [reserved](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2) and [unreserved](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3), and defines the unsafe set as all characters not included in either of those sets. @@ -4478,11 +4478,11 @@ Unfortunately, these specifications each define slightly different percent-encod This specification normatively cites the following relevant standards: -| Specification | Date | OAS Usage | Percent-Encoding | Notes | -| ---- | ---- | ---- | ---- | ---- | -| [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) | 01/2005 | URI/URL syntax | [[RFC3986]] | obsoletes [[RFC1738]], [[RFC2396]] | -| [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) | 03/2012 | style-based serialization | [[RFC3986]] | does not use `+` for form‑urlencoded | -| [RFC1866](https://datatracker.ietf.org/doc/html/rfc1866#section-8.2.1) | 11/1995 | content-based serialization | [[RFC1738]] | obsoleted by [[HTML401]] [Section 17.13.4.1](https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1), [[URL]] [Section 5](https://url.spec.whatwg.org/#urlencoded-serializing) | +| Specification | Date | OAS Usage | Percent-Encoding | Notes | +| ---------------------------------------------------------------------- | ------- | --------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) | 01/2005 | URI/URL syntax | [[RFC3986]] | obsoletes [[RFC1738]], [[RFC2396]] | +| [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) | 03/2012 | style-based serialization | [[RFC3986]] | does not use `+` for form‑urlencoded | +| [RFC1866](https://datatracker.ietf.org/doc/html/rfc1866#section-8.2.1) | 11/1995 | content-based serialization | [[RFC1738]] | obsoleted by [[HTML401]] [Section 17.13.4.1](https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1), [[URL]] [Section 5](https://url.spec.whatwg.org/#urlencoded-serializing) | Style-based serialization is used in the [Parameter Object](#parameter-object) when `schema` is present, and in the [Encoding Object](#encoding-object) when at least one of `style`, `explode`, or `allowReserved` is present. See [Appendix C](#appendix-c-using-rfc6570-based-serialization) for more details of RFC6570's two different approaches to percent-encoding, including an example involving `+`. @@ -4573,7 +4573,7 @@ components: bearerFormat: JWT paths: /foo: - $ref: 'other#/components/pathItems/Foo' + $ref: "other#/components/pathItems/Foo" ``` This entry document references another document, `other`, without using a file extension. This gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available: diff --git a/3.1/components.ts b/3.1/components.ts index cfaab22..6f71c41 100644 --- a/3.1/components.ts +++ b/3.1/components.ts @@ -1,13 +1,13 @@ import type { Extension } from "./extensions"; import type { - Callback, - Example, - Header, - Link, - Parameter, - PathItem, - RequestBody, - Response, + Callback, + Example, + Header, + Link, + Parameter, + PathItem, + RequestBody, + Response, } from "./paths"; import type { Reference } from "./references"; import type { Schema } from "./schema"; @@ -71,73 +71,73 @@ import type { SecurityScheme } from "./security"; * ``` */ export interface Components extends Extension { - /** - * An object to hold reusable Schema Objects. - * - * @example { User: { type: "object", properties: { id: { type: "integer" } } } } - */ - schemas?: Record; + /** + * An object to hold reusable Schema Objects. + * + * @example { User: { type: "object", properties: { id: { type: "integer" } } } } + */ + schemas?: Record; - /** - * An object to hold reusable Response Objects. - * - * @example { NotFound: { description: "Resource not found" } } - */ - responses?: Record; + /** + * An object to hold reusable Response Objects. + * + * @example { NotFound: { description: "Resource not found" } } + */ + responses?: Record; - /** - * An object to hold reusable Parameter Objects. - * - * @example { UserId: { name: "userId", in: "path", required: true, schema: { type: "string" } } } - */ - parameters?: Record; + /** + * An object to hold reusable Parameter Objects. + * + * @example { UserId: { name: "userId", in: "path", required: true, schema: { type: "string" } } } + */ + parameters?: Record; - /** - * An object to hold reusable Example Objects. - * - * @example { UserExample: { value: { id: 1, name: "John Doe" } } } - */ - examples?: Record; + /** + * An object to hold reusable Example Objects. + * + * @example { UserExample: { value: { id: 1, name: "John Doe" } } } + */ + examples?: Record; - /** - * An object to hold reusable Request Body Objects. - * - * @example { UserRequestBody: { description: "User data", content: { "application/json": { schema: { $ref: "#/components/schemas/User" } } } } } - */ - requestBodies?: Record; + /** + * An object to hold reusable Request Body Objects. + * + * @example { UserRequestBody: { description: "User data", content: { "application/json": { schema: { $ref: "#/components/schemas/User" } } } } } + */ + requestBodies?: Record; - /** - * An object to hold reusable Header Objects. - * - * @example { RateLimit: { description: "Rate limit per hour", schema: { type: "integer" } } } - */ - headers?: Record; + /** + * An object to hold reusable Header Objects. + * + * @example { RateLimit: { description: "Rate limit per hour", schema: { type: "integer" } } } + */ + headers?: Record; - /** - * An object to hold reusable Security Scheme Objects. - * - * @example { ApiKeyAuth: { type: "apiKey", in: "header", name: "X-API-KEY" } } - */ - securitySchemes?: Record; + /** + * An object to hold reusable Security Scheme Objects. + * + * @example { ApiKeyAuth: { type: "apiKey", in: "header", name: "X-API-KEY" } } + */ + securitySchemes?: Record; - /** - * An object to hold reusable Link Objects. - * - * @example { UserOrders: { operationId: "getOrdersByUserId", parameters: { userId: "$response.body#/id" } } } - */ - links?: Record; + /** + * An object to hold reusable Link Objects. + * + * @example { UserOrders: { operationId: "getOrdersByUserId", parameters: { userId: "$response.body#/id" } } } + */ + links?: Record; - /** - * An object to hold reusable Callback Objects. - * - * @example { UserCreatedCallback: { "{$request.body#/callbackUrl}": { post: { requestBody: { description: "User created event" } } } } } - */ - callbacks?: Record; + /** + * An object to hold reusable Callback Objects. + * + * @example { UserCreatedCallback: { "{$request.body#/callbackUrl}": { post: { requestBody: { description: "User created event" } } } } } + */ + callbacks?: Record; - /** - * An object to hold reusable Path Item Objects. - * - * @example { UserPath: { get: { summary: "Get user by ID" } } } - */ - pathItems?: Record; + /** + * An object to hold reusable Path Item Objects. + * + * @example { UserPath: { get: { summary: "Get user by ID" } } } + */ + pathItems?: Record; } diff --git a/3.1/data-types/array.ts b/3.1/data-types/array.ts index 1eb0e6e..38972d7 100644 --- a/3.1/data-types/array.ts +++ b/3.1/data-types/array.ts @@ -83,137 +83,137 @@ import type { XML } from "../xml"; * ``` */ export interface ArraySchema extends Extension { - /** - * The type identifier for array schemas. - * Must be "array". - */ - type: "array"; + /** + * The type identifier for array schemas. + * Must be "array". + */ + type: "array"; - /** - * The schema for array items. - * All items in the array must conform to this schema. - * - * Example: `{ type: "string" }` - */ - items?: unknown; + /** + * The schema for array items. + * All items in the array must conform to this schema. + * + * Example: `{ type: "string" }` + */ + items?: unknown; - /** - * The schema for array items at specific positions. - * Items at position i must conform to the schema at index i. - * - * Example: `[{ type: "string" }, { type: "number" }]` - */ - prefixItems?: unknown[]; + /** + * The schema for array items at specific positions. + * Items at position i must conform to the schema at index i. + * + * Example: `[{ type: "string" }, { type: "number" }]` + */ + prefixItems?: unknown[]; - /** - * The schema that the array must contain at least one item matching. - * At least one item in the array must conform to this schema. - * - * Example: `{ type: "string", enum: ["admin"] }` - */ - contains?: unknown; + /** + * The schema that the array must contain at least one item matching. + * At least one item in the array must conform to this schema. + * + * Example: `{ type: "string", enum: ["admin"] }` + */ + contains?: unknown; - /** - * The minimum number of items that must match the contains schema. - * Must be a non-negative integer. - * - * Example: `1` - */ - minContains?: number; + /** + * The minimum number of items that must match the contains schema. + * Must be a non-negative integer. + * + * Example: `1` + */ + minContains?: number; - /** - * The maximum number of items that must match the contains schema. - * Must be a non-negative integer. - * - * Example: `5` - */ - maxContains?: number; + /** + * The maximum number of items that must match the contains schema. + * Must be a non-negative integer. + * + * Example: `5` + */ + maxContains?: number; - /** - * The minimum number of items in the array. - * Must be a non-negative integer. - * - * Example: `1` - */ - minItems?: number; + /** + * The minimum number of items in the array. + * Must be a non-negative integer. + * + * Example: `1` + */ + minItems?: number; - /** - * The maximum number of items in the array. - * Must be a non-negative integer. - * - * Example: `10` - */ - maxItems?: number; + /** + * The maximum number of items in the array. + * Must be a non-negative integer. + * + * Example: `10` + */ + maxItems?: number; - /** - * Whether array items must be unique. - * If true, all items in the array must be unique. - * - * Example: `true` - */ - uniqueItems?: boolean; + /** + * Whether array items must be unique. + * If true, all items in the array must be unique. + * + * Example: `true` + */ + uniqueItems?: boolean; - /** - * An array of allowed values for the array. - * The value must be one of the values in this array. - * - * Example: `[["a", "b"], ["c", "d"]]` - */ - enum?: unknown[]; + /** + * An array of allowed values for the array. + * The value must be one of the values in this array. + * + * Example: `[["a", "b"], ["c", "d"]]` + */ + enum?: unknown[]; - /** - * A single allowed value for the array. - * The value must be exactly this value. - * - * Example: `["a", "b"]` - */ - const?: unknown; + /** + * A single allowed value for the array. + * The value must be exactly this value. + * + * Example: `["a", "b"]` + */ + const?: unknown; - /** - * An example value for the array. - * This is for documentation purposes only. - * - * Example: `["a", "b"]` - */ - example?: unknown[]; + /** + * An example value for the array. + * This is for documentation purposes only. + * + * Example: `["a", "b"]` + */ + example?: unknown[]; - /** - * An array of example values for the array. - * These are for documentation purposes only. - * - * Example: `[["a", "b"], ["c", "d"]]` - */ - examples?: unknown[][]; + /** + * An array of example values for the array. + * These are for documentation purposes only. + * + * Example: `[["a", "b"], ["c", "d"]]` + */ + examples?: unknown[][]; - /** - * The default value for the array. - * This value will be used if no value is provided. - * - * Example: `[]` - */ - default?: unknown[]; + /** + * The default value for the array. + * This value will be used if no value is provided. + * + * Example: `[]` + */ + default?: unknown[]; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"User Tags"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"User Tags"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"Array of user tags"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"Array of user tags"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * Example: `{ name: "users", wrapped: true }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * Example: `{ name: "users", wrapped: true }` + */ + xml?: XML; } diff --git a/3.1/data-types/boolean.ts b/3.1/data-types/boolean.ts index 0e41122..77ba4d0 100644 --- a/3.1/data-types/boolean.ts +++ b/3.1/data-types/boolean.ts @@ -66,73 +66,73 @@ import type { XML } from "../xml"; * ``` */ export interface BooleanSchema extends Extension { - /** - * The type identifier for boolean schemas. - * Must be "boolean". - */ - type: "boolean"; + /** + * The type identifier for boolean schemas. + * Must be "boolean". + */ + type: "boolean"; - /** - * An array of allowed values for the boolean. - * The value must be one of the values in this array. - * - * Example: `[true, false]` - */ - enum?: boolean[]; + /** + * An array of allowed values for the boolean. + * The value must be one of the values in this array. + * + * Example: `[true, false]` + */ + enum?: boolean[]; - /** - * A single allowed value for the boolean. - * The value must be exactly this value. - * - * Example: `true` - */ - const?: boolean; + /** + * A single allowed value for the boolean. + * The value must be exactly this value. + * + * Example: `true` + */ + const?: boolean; - /** - * An example value for the boolean. - * This is for documentation purposes only. - * - * Example: `true` - */ - example?: boolean; + /** + * An example value for the boolean. + * This is for documentation purposes only. + * + * Example: `true` + */ + example?: boolean; - /** - * An array of example values for the boolean. - * These are for documentation purposes only. - * - * Example: `[true, false]` - */ - examples?: boolean[]; + /** + * An array of example values for the boolean. + * These are for documentation purposes only. + * + * Example: `[true, false]` + */ + examples?: boolean[]; - /** - * The default value for the boolean. - * This value will be used if no value is provided. - * - * Example: `false` - */ - default?: boolean; + /** + * The default value for the boolean. + * This value will be used if no value is provided. + * + * Example: `false` + */ + default?: boolean; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"Is Active"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"Is Active"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"Whether the user is active"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"Whether the user is active"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * Example: `{ name: "isActive", attribute: false }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * Example: `{ name: "isActive", attribute: false }` + */ + xml?: XML; } diff --git a/3.1/data-types/composition.ts b/3.1/data-types/composition.ts index df04595..5df87d6 100644 --- a/3.1/data-types/composition.ts +++ b/3.1/data-types/composition.ts @@ -84,123 +84,123 @@ import type { XML } from "../xml"; * ``` */ export interface CompositionSchema extends Extension { - /** - * An array of schemas that must all be satisfied. - * The value must conform to all schemas in the array. - * - * Example: `[{ type: "object" }, { properties: { name: { type: "string" } } }]` - */ - allOf?: unknown[]; + /** + * An array of schemas that must all be satisfied. + * The value must conform to all schemas in the array. + * + * Example: `[{ type: "object" }, { properties: { name: { type: "string" } } }]` + */ + allOf?: unknown[]; - /** - * An array of schemas where at least one must be satisfied. - * The value must conform to at least one schema in the array. - * - * Example: `[{ type: "string" }, { type: "number" }]` - */ - anyOf?: unknown[]; + /** + * An array of schemas where at least one must be satisfied. + * The value must conform to at least one schema in the array. + * + * Example: `[{ type: "string" }, { type: "number" }]` + */ + anyOf?: unknown[]; - /** - * An array of schemas where exactly one must be satisfied. - * The value must conform to exactly one schema in the array. - * - * Example: `[{ type: "string" }, { type: "number" }]` - */ - oneOf?: unknown[]; + /** + * An array of schemas where exactly one must be satisfied. + * The value must conform to exactly one schema in the array. + * + * Example: `[{ type: "string" }, { type: "number" }]` + */ + oneOf?: unknown[]; - /** - * A schema that must not be satisfied. - * The value must not conform to this schema. - * - * Example: `{ type: "string" }` - */ - not?: unknown; + /** + * A schema that must not be satisfied. + * The value must not conform to this schema. + * + * Example: `{ type: "string" }` + */ + not?: unknown; - /** - * A schema for conditional validation. - * Used with `then` and `else` for conditional logic. - * - * Example: `{ type: "object", properties: { type: { const: "user" } } }` - */ - if?: unknown; + /** + * A schema for conditional validation. + * Used with `then` and `else` for conditional logic. + * + * Example: `{ type: "object", properties: { type: { const: "user" } } }` + */ + if?: unknown; - /** - * A schema to apply if the `if` condition is met. - * The value must conform to this schema if the `if` schema is satisfied. - * - * Example: `{ type: "object", properties: { name: { type: "string" } } }` - */ - then?: unknown; + /** + * A schema to apply if the `if` condition is met. + * The value must conform to this schema if the `if` schema is satisfied. + * + * Example: `{ type: "object", properties: { name: { type: "string" } } }` + */ + then?: unknown; - /** - * A schema to apply if the `if` condition is not met. - * The value must conform to this schema if the `if` schema is not satisfied. - * - * Example: `{ type: "object", properties: { id: { type: "string" } } }` - */ - else?: unknown; + /** + * A schema to apply if the `if` condition is not met. + * The value must conform to this schema if the `if` schema is not satisfied. + * + * Example: `{ type: "object", properties: { id: { type: "string" } } }` + */ + else?: unknown; - /** - * An array of allowed values. - * The value must be one of the values in this array. - * - * Example: `["active", "inactive"]` - */ - enum?: unknown[]; + /** + * An array of allowed values. + * The value must be one of the values in this array. + * + * Example: `["active", "inactive"]` + */ + enum?: unknown[]; - /** - * A single allowed value. - * The value must be exactly this value. - * - * Example: `"active"` - */ - const?: unknown; + /** + * A single allowed value. + * The value must be exactly this value. + * + * Example: `"active"` + */ + const?: unknown; - /** - * An example value for the composition. - * This is for documentation purposes only. - * - * Example: `"example"` - */ - example?: unknown; + /** + * An example value for the composition. + * This is for documentation purposes only. + * + * Example: `"example"` + */ + example?: unknown; - /** - * An array of example values. - * These are for documentation purposes only. - * - * Example: `["example1", "example2"]` - */ - examples?: unknown[]; + /** + * An array of example values. + * These are for documentation purposes only. + * + * Example: `["example1", "example2"]` + */ + examples?: unknown[]; - /** - * The default value. - * This value will be used if no value is provided. - * - * Example: `"default"` - */ - default?: unknown; + /** + * The default value. + * This value will be used if no value is provided. + * + * Example: `"default"` + */ + default?: unknown; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"Composed Schema"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"Composed Schema"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"A schema composed of multiple schemas"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"A schema composed of multiple schemas"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * Example: `{ name: "composedSchema", attribute: false }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * Example: `{ name: "composedSchema", attribute: false }` + */ + xml?: XML; } diff --git a/3.1/data-types/integer.ts b/3.1/data-types/integer.ts index cda1073..db8be18 100644 --- a/3.1/data-types/integer.ts +++ b/3.1/data-types/integer.ts @@ -75,121 +75,121 @@ import type { XML } from "../xml"; * ``` */ export interface IntegerSchema extends Extension { - /** - * The type identifier for integer schemas. - * Must be "integer". - */ - type: "integer"; + /** + * The type identifier for integer schemas. + * Must be "integer". + */ + type: "integer"; - /** - * The format of the integer. - * See OpenAPI 3.1.x Data Type Formats for further details. - * - * Example: `"int32"`, `"int64"` - */ - format?: string; + /** + * The format of the integer. + * See OpenAPI 3.1.x Data Type Formats for further details. + * + * Example: `"int32"`, `"int64"` + */ + format?: string; - /** - * The integer must be a multiple of this value. - * Must be a positive integer. - * - * Example: `5` - */ - multipleOf?: number; + /** + * The integer must be a multiple of this value. + * Must be a positive integer. + * + * Example: `5` + */ + multipleOf?: number; - /** - * The maximum value of the integer (inclusive). - * The integer must be less than or equal to this value. - * - * Example: `100` - */ - maximum?: number; + /** + * The maximum value of the integer (inclusive). + * The integer must be less than or equal to this value. + * + * Example: `100` + */ + maximum?: number; - /** - * The minimum value of the integer (inclusive). - * The integer must be greater than or equal to this value. - * - * Example: `0` - */ - minimum?: number; + /** + * The minimum value of the integer (inclusive). + * The integer must be greater than or equal to this value. + * + * Example: `0` + */ + minimum?: number; - /** - * The maximum value of the integer (exclusive). - * The integer must be less than this value. - * - * Example: `100` - */ - exclusiveMaximum?: number; + /** + * The maximum value of the integer (exclusive). + * The integer must be less than this value. + * + * Example: `100` + */ + exclusiveMaximum?: number; - /** - * The minimum value of the integer (exclusive). - * The integer must be greater than this value. - * - * Example: `0` - */ - exclusiveMinimum?: number; + /** + * The minimum value of the integer (exclusive). + * The integer must be greater than this value. + * + * Example: `0` + */ + exclusiveMinimum?: number; - /** - * An array of allowed values for the integer. - * The value must be one of the values in this array. - * - * Example: `[1, 2, 3, 4, 5]` - */ - enum?: number[]; + /** + * An array of allowed values for the integer. + * The value must be one of the values in this array. + * + * Example: `[1, 2, 3, 4, 5]` + */ + enum?: number[]; - /** - * A single allowed value for the integer. - * The value must be exactly this value. - * - * Example: `42` - */ - const?: number; + /** + * A single allowed value for the integer. + * The value must be exactly this value. + * + * Example: `42` + */ + const?: number; - /** - * An example value for the integer. - * This is for documentation purposes only. - * - * Example: `42` - */ - example?: number; + /** + * An example value for the integer. + * This is for documentation purposes only. + * + * Example: `42` + */ + example?: number; - /** - * An array of example values for the integer. - * These are for documentation purposes only. - * - * Example: `[1, 2, 3]` - */ - examples?: number[]; + /** + * An array of example values for the integer. + * These are for documentation purposes only. + * + * Example: `[1, 2, 3]` + */ + examples?: number[]; - /** - * The default value for the integer. - * This value will be used if no value is provided. - * - * Example: `0` - */ - default?: number; + /** + * The default value for the integer. + * This value will be used if no value is provided. + * + * Example: `0` + */ + default?: number; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"User ID"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"User ID"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"The unique identifier of the user"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"The unique identifier of the user"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * Example: `{ name: "userId", attribute: false }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * Example: `{ name: "userId", attribute: false }` + */ + xml?: XML; } diff --git a/3.1/data-types/null.ts b/3.1/data-types/null.ts index 0c45564..497023b 100644 --- a/3.1/data-types/null.ts +++ b/3.1/data-types/null.ts @@ -57,52 +57,52 @@ import type { Extension } from "../extensions"; * ``` */ export interface NullSchema extends Extension { - /** - * The type identifier for null schemas. This field is required. - * - * @example "null" - */ - type: "null"; + /** + * The type identifier for null schemas. This field is required. + * + * @example "null" + */ + type: "null"; - /** - * A short title for the schema. - * - * @example "Null Value" - */ - title?: string; + /** + * A short title for the schema. + * + * @example "Null Value" + */ + title?: string; - /** - * A description of the schema. CommonMark syntax MAY be used for rich text representation. - * - * @example "Represents a null value" - */ - description?: string; + /** + * A description of the schema. CommonMark syntax MAY be used for rich text representation. + * + * @example "Represents a null value" + */ + description?: string; - /** - * The default value for the schema. - * - * @example null - */ - default?: null; + /** + * The default value for the schema. + * + * @example null + */ + default?: null; - /** - * An array of example values. - * - * @example [null] - */ - examples?: null[]; + /** + * An array of example values. + * + * @example [null] + */ + examples?: null[]; - /** - * An enumeration of allowed values. For null schemas, this should contain only null. - * - * @example [null] - */ - enum?: null[]; + /** + * An enumeration of allowed values. For null schemas, this should contain only null. + * + * @example [null] + */ + enum?: null[]; - /** - * A constant allowed value. For null schemas, this should be null. - * - * @example null - */ - const?: null; + /** + * A constant allowed value. For null schemas, this should be null. + * + * @example null + */ + const?: null; } diff --git a/3.1/data-types/number.ts b/3.1/data-types/number.ts index 05ae657..5a76e9b 100644 --- a/3.1/data-types/number.ts +++ b/3.1/data-types/number.ts @@ -75,121 +75,121 @@ import type { XML } from "../xml"; * ``` */ export interface NumberSchema extends Extension { - /** - * The type identifier for number schemas. - * Must be "number". - */ - type: "number"; + /** + * The type identifier for number schemas. + * Must be "number". + */ + type: "number"; - /** - * The format of the number. - * See OpenAPI 3.1.x Data Type Formats for further details. - * - * Example: `"float"`, `"double"` - */ - format?: string; + /** + * The format of the number. + * See OpenAPI 3.1.x Data Type Formats for further details. + * + * Example: `"float"`, `"double"` + */ + format?: string; - /** - * The number must be a multiple of this value. - * Must be a positive number. - * - * Example: `0.5` - */ - multipleOf?: number; + /** + * The number must be a multiple of this value. + * Must be a positive number. + * + * Example: `0.5` + */ + multipleOf?: number; - /** - * The maximum value of the number (inclusive). - * The number must be less than or equal to this value. - * - * Example: `100` - */ - maximum?: number; + /** + * The maximum value of the number (inclusive). + * The number must be less than or equal to this value. + * + * Example: `100` + */ + maximum?: number; - /** - * The minimum value of the number (inclusive). - * The number must be greater than or equal to this value. - * - * Example: `0` - */ - minimum?: number; + /** + * The minimum value of the number (inclusive). + * The number must be greater than or equal to this value. + * + * Example: `0` + */ + minimum?: number; - /** - * The maximum value of the number (exclusive). - * The number must be less than this value. - * - * Example: `100` - */ - exclusiveMaximum?: number; + /** + * The maximum value of the number (exclusive). + * The number must be less than this value. + * + * Example: `100` + */ + exclusiveMaximum?: number; - /** - * The minimum value of the number (exclusive). - * The number must be greater than this value. - * - * Example: `0` - */ - exclusiveMinimum?: number; + /** + * The minimum value of the number (exclusive). + * The number must be greater than this value. + * + * Example: `0` + */ + exclusiveMinimum?: number; - /** - * An array of allowed values for the number. - * The value must be one of the values in this array. - * - * Example: `[1, 2, 3, 4, 5]` - */ - enum?: number[]; + /** + * An array of allowed values for the number. + * The value must be one of the values in this array. + * + * Example: `[1, 2, 3, 4, 5]` + */ + enum?: number[]; - /** - * A single allowed value for the number. - * The value must be exactly this value. - * - * Example: `42` - */ - const?: number; + /** + * A single allowed value for the number. + * The value must be exactly this value. + * + * Example: `42` + */ + const?: number; - /** - * An example value for the number. - * This is for documentation purposes only. - * - * Example: `42` - */ - example?: number; + /** + * An example value for the number. + * This is for documentation purposes only. + * + * Example: `42` + */ + example?: number; - /** - * An array of example values for the number. - * These are for documentation purposes only. - * - * Example: `[1.5, 2.7, 3.14]` - */ - examples?: number[]; + /** + * An array of example values for the number. + * These are for documentation purposes only. + * + * Example: `[1.5, 2.7, 3.14]` + */ + examples?: number[]; - /** - * The default value for the number. - * This value will be used if no value is provided. - * - * Example: `0` - */ - default?: number; + /** + * The default value for the number. + * This value will be used if no value is provided. + * + * Example: `0` + */ + default?: number; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"Price"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"Price"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"The price of the item"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"The price of the item"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * Example: `{ name: "price", attribute: false }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * Example: `{ name: "price", attribute: false }` + */ + xml?: XML; } diff --git a/3.1/data-types/object.ts b/3.1/data-types/object.ts index a3a2831..5351959 100644 --- a/3.1/data-types/object.ts +++ b/3.1/data-types/object.ts @@ -88,147 +88,147 @@ import type { XML } from "../xml"; * ``` */ export interface ObjectSchema extends Extension { - /** - * The type identifier for object schemas. - * Must be "object". - */ - type: "object"; + /** + * The type identifier for object schemas. + * Must be "object". + */ + type: "object"; - /** - * A map of property names to their schemas. - * Each property in the object must conform to its corresponding schema. - * - * Example: `{ name: { type: "string" }, age: { type: "number" } }` - */ - properties?: Record; + /** + * A map of property names to their schemas. + * Each property in the object must conform to its corresponding schema. + * + * Example: `{ name: { type: "string" }, age: { type: "number" } }` + */ + properties?: Record; - /** - * An array of required property names. - * These properties must be present in the object. - * - * Example: `["name", "email"]` - */ - required?: string[]; + /** + * An array of required property names. + * These properties must be present in the object. + * + * Example: `["name", "email"]` + */ + required?: string[]; - /** - * The schema for additional properties not defined in properties. - * If false, no additional properties are allowed. - * If true, any additional properties are allowed. - * If a schema, additional properties must conform to this schema. - * - * Example: `{ type: "string" }` or `false` or `true` - */ - additionalProperties?: unknown | boolean; + /** + * The schema for additional properties not defined in properties. + * If false, no additional properties are allowed. + * If true, any additional properties are allowed. + * If a schema, additional properties must conform to this schema. + * + * Example: `{ type: "string" }` or `false` or `true` + */ + additionalProperties?: unknown | boolean; - /** - * A map of regex patterns to schemas. - * Properties whose names match a pattern must conform to the corresponding schema. - * - * Example: `{ "^S_": { type: "string" } }` - */ - patternProperties?: Record; + /** + * A map of regex patterns to schemas. + * Properties whose names match a pattern must conform to the corresponding schema. + * + * Example: `{ "^S_": { type: "string" } }` + */ + patternProperties?: Record; - /** - * The schema for property names. - * All property names in the object must conform to this schema. - * - * Example: `{ type: "string", pattern: "^[A-Za-z][A-Za-z0-9]*$" }` - */ - propertyNames?: unknown; + /** + * The schema for property names. + * All property names in the object must conform to this schema. + * + * Example: `{ type: "string", pattern: "^[A-Za-z][A-Za-z0-9]*$" }` + */ + propertyNames?: unknown; - /** - * The minimum number of properties in the object. - * Must be a non-negative integer. - * - * Example: `1` - */ - minProperties?: number; + /** + * The minimum number of properties in the object. + * Must be a non-negative integer. + * + * Example: `1` + */ + minProperties?: number; - /** - * The maximum number of properties in the object. - * Must be a non-negative integer. - * - * Example: `10` - */ - maxProperties?: number; + /** + * The maximum number of properties in the object. + * Must be a non-negative integer. + * + * Example: `10` + */ + maxProperties?: number; - /** - * A map of property names to arrays of required properties. - * If a property is present, the properties in its array must also be present. - * - * Example: `{ credit_card: ["billing_address"] }` - */ - dependentRequired?: Record; + /** + * A map of property names to arrays of required properties. + * If a property is present, the properties in its array must also be present. + * + * Example: `{ credit_card: ["billing_address"] }` + */ + dependentRequired?: Record; - /** - * A map of property names to schemas. - * If a property is present, the object must conform to the corresponding schema. - * - * Example: `{ credit_card: { type: "object", properties: { number: { type: "string" } } } }` - */ - dependentSchemas?: Record; + /** + * A map of property names to schemas. + * If a property is present, the object must conform to the corresponding schema. + * + * Example: `{ credit_card: { type: "object", properties: { number: { type: "string" } } } }` + */ + dependentSchemas?: Record; - /** - * An array of allowed values for the object. - * The value must be one of the values in this array. - * - * Example: `[{ name: "John" }, { name: "Jane" }]` - */ - enum?: Record[]; + /** + * An array of allowed values for the object. + * The value must be one of the values in this array. + * + * Example: `[{ name: "John" }, { name: "Jane" }]` + */ + enum?: Record[]; - /** - * A single allowed value for the object. - * The value must be exactly this value. - * - * Example: `{ name: "John" }` - */ - const?: Record; + /** + * A single allowed value for the object. + * The value must be exactly this value. + * + * Example: `{ name: "John" }` + */ + const?: Record; - /** - * An example value for the object. - * This is for documentation purposes only. - * - * Example: `{ name: "John" }` - */ - example?: Record; + /** + * An example value for the object. + * This is for documentation purposes only. + * + * Example: `{ name: "John" }` + */ + example?: Record; - /** - * An array of example values for the object. - * These are for documentation purposes only. - * - * Example: `[{ name: "John", age: 30 }]` - */ - examples?: Record[]; + /** + * An array of example values for the object. + * These are for documentation purposes only. + * + * Example: `[{ name: "John", age: 30 }]` + */ + examples?: Record[]; - /** - * The default value for the object. - * This value will be used if no value is provided. - * - * Example: `{}` - */ - default?: Record; + /** + * The default value for the object. + * This value will be used if no value is provided. + * + * Example: `{}` + */ + default?: Record; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"User"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"User"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"A user object"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"A user object"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * Example: `{ name: "user", attribute: false }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * Example: `{ name: "user", attribute: false }` + */ + xml?: XML; } diff --git a/3.1/data-types/reference.ts b/3.1/data-types/reference.ts index a8a6aa0..b7cea28 100644 --- a/3.1/data-types/reference.ts +++ b/3.1/data-types/reference.ts @@ -53,19 +53,19 @@ import type { Extension } from "../extensions"; * ``` */ export interface ReferenceSchema extends Extension { - /** - * A reference to a schema. This MUST be in the form of a URI. - * When present, no other properties except `description` and extensions are allowed. - * - * Example: `"#/components/schemas/User"` - */ - $ref: string; + /** + * A reference to a schema. This MUST be in the form of a URI. + * When present, no other properties except `description` and extensions are allowed. + * + * Example: `"#/components/schemas/User"` + */ + $ref: string; - /** - * A description of the referenced schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"Reference to a user schema"` - */ - description?: string; + /** + * A description of the referenced schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"Reference to a user schema"` + */ + description?: string; } diff --git a/3.1/data-types/string.ts b/3.1/data-types/string.ts index db9df9b..5748f15 100644 --- a/3.1/data-types/string.ts +++ b/3.1/data-types/string.ts @@ -84,121 +84,121 @@ import type { XML } from "../xml"; * ``` */ export interface StringSchema extends Extension { - /** - * The type identifier for string schemas. - * Must be "string". - */ - type: "string"; + /** + * The type identifier for string schemas. + * Must be "string". + */ + type: "string"; - /** - * The format of the string. - * See OpenAPI 3.1.x Data Type Formats for further details. - * - * Example: `"email"`, `"date-time"`, `"uuid"` - */ - format?: string; + /** + * The format of the string. + * See OpenAPI 3.1.x Data Type Formats for further details. + * + * Example: `"email"`, `"date-time"`, `"uuid"` + */ + format?: string; - /** - * The maximum length of the string. - * Must be a non-negative integer. - * - * Example: `255` - */ - maxLength?: number; + /** + * The maximum length of the string. + * Must be a non-negative integer. + * + * Example: `255` + */ + maxLength?: number; - /** - * The minimum length of the string. - * Must be a non-negative integer. - * - * Example: `1` - */ - minLength?: number; + /** + * The minimum length of the string. + * Must be a non-negative integer. + * + * Example: `1` + */ + minLength?: number; - /** - * A regular expression pattern that the string must match. - * Should be a valid ECMA 262 regular expression. - * - * Example: `"^[A-Za-z0-9]+$"` - */ - pattern?: string; + /** + * A regular expression pattern that the string must match. + * Should be a valid ECMA 262 regular expression. + * + * Example: `"^[A-Za-z0-9]+$"` + */ + pattern?: string; - /** - * An array of allowed values for the string. - * The value must be one of the values in this array. - * - * Example: `["active", "inactive", "pending"]` - */ - enum?: string[]; + /** + * An array of allowed values for the string. + * The value must be one of the values in this array. + * + * Example: `["active", "inactive", "pending"]` + */ + enum?: string[]; - /** - * A single allowed value for the string. - * The value must be exactly this value. - * - * Example: `"active"` - */ - const?: string; + /** + * A single allowed value for the string. + * The value must be exactly this value. + * + * Example: `"active"` + */ + const?: string; - /** - * An example value for the string. - * This is for documentation purposes only. - * - * Example: `"example@email.com"` - */ - example?: string; + /** + * An example value for the string. + * This is for documentation purposes only. + * + * Example: `"example@email.com"` + */ + example?: string; - /** - * An array of example values for the string. - * These are for documentation purposes only. - * - * Example: `["example@email.com", "test@domain.com"]` - */ - examples?: string[]; + /** + * An array of example values for the string. + * These are for documentation purposes only. + * + * Example: `["example@email.com", "test@domain.com"]` + */ + examples?: string[]; - /** - * The default value for the string. - * This value will be used if no value is provided. - * - * Example: `"default"` - */ - default?: string; + /** + * The default value for the string. + * This value will be used if no value is provided. + * + * Example: `"default"` + */ + default?: string; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"User Email"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"User Email"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"The email address of the user"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"The email address of the user"` + */ + description?: string; - /** - * The media type of the content. This is used to specify the media type - * of the content when the string represents encoded content. - * - * Example: `"image/png"`, `"application/json"` - */ - contentMediaType?: string; + /** + * The media type of the content. This is used to specify the media type + * of the content when the string represents encoded content. + * + * Example: `"image/png"`, `"application/json"` + */ + contentMediaType?: string; - /** - * The encoding of the content. This is used to specify how the content - * is encoded when the string represents encoded content. - * - * Example: `"base64"`, `"base64url"`, `"quoted-printable"` - */ - contentEncoding?: string; + /** + * The encoding of the content. This is used to specify how the content + * is encoded when the string represents encoded content. + * + * Example: `"base64"`, `"base64url"`, `"quoted-printable"` + */ + contentEncoding?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions. - * - * Example: `{ name: "userName", attribute: false }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions. + * + * Example: `{ name: "userName", attribute: false }` + */ + xml?: XML; } diff --git a/3.1/extensions.ts b/3.1/extensions.ts index 447c3cd..3c0fb39 100644 --- a/3.1/extensions.ts +++ b/3.1/extensions.ts @@ -51,13 +51,13 @@ * ``` */ export interface Extension { - /** - * Specification Extensions allow adding custom properties to OpenAPI objects. - * All extension properties must start with `x-` and can contain any valid JSON value. - * - * @example "x-custom-property" - * @example "x-internal-id" - * @example "x-codegen-settings" - */ - [key: `x-${string}`]: unknown; + /** + * Specification Extensions allow adding custom properties to OpenAPI objects. + * All extension properties must start with `x-` and can contain any valid JSON value. + * + * @example "x-custom-property" + * @example "x-internal-id" + * @example "x-codegen-settings" + */ + [key: `x-${string}`]: unknown; } diff --git a/3.1/externalDocs.ts b/3.1/externalDocs.ts index 4ebae54..741b084 100644 --- a/3.1/externalDocs.ts +++ b/3.1/externalDocs.ts @@ -43,21 +43,21 @@ import type { Extension } from "./extensions"; * ``` */ export interface ExternalDocumentation extends Extension { - /** - * A short description of the target documentation. CommonMark syntax MAY be used - * for rich text representation. - * - * @example "Find out more about our API" - * @example "Additional documentation for this endpoint" - */ - description?: string; + /** + * A short description of the target documentation. CommonMark syntax MAY be used + * for rich text representation. + * + * @example "Find out more about our API" + * @example "Additional documentation for this endpoint" + */ + description?: string; - /** - * The URL for the target documentation. This field is required and MUST be in the - * format of a URL. - * - * @example "https://example.com/docs" - * @example "https://docs.example.com/api" - */ - url: string; + /** + * The URL for the target documentation. This field is required and MUST be in the + * format of a URL. + * + * @example "https://example.com/docs" + * @example "https://docs.example.com/api" + */ + url: string; } diff --git a/3.1/index.ts b/3.1/index.ts index 2f527ee..bd85586 100644 --- a/3.1/index.ts +++ b/3.1/index.ts @@ -24,14 +24,14 @@ export type { Components } from "./components"; * @see {@link https://spec.openapis.org/oas/v3.1.1#data-type-object | OpenAPI 3.1.1 Data Type Object} */ export type { - ArraySchema, - BooleanSchema, - CompositionSchema, - IntegerSchema, - NumberSchema, - ObjectSchema, - ReferenceSchema, - StringSchema, + ArraySchema, + BooleanSchema, + CompositionSchema, + IntegerSchema, + NumberSchema, + ObjectSchema, + ReferenceSchema, + StringSchema, } from "./data-types"; /** * Core extension and reference types. @@ -67,18 +67,18 @@ export type { Contact, Info, License } from "./info"; * @see {@link https://spec.openapis.org/oas/v3.1.1#callback-object | OpenAPI 3.1.1 Callback Object} */ export type { - Callback, - Encoding, - Example, - Header, - Link, - MediaType, - Operation, - Parameter, - PathItem, - Paths, - RequestBody, - Response, + Callback, + Encoding, + Example, + Header, + Link, + MediaType, + Operation, + Parameter, + PathItem, + Paths, + RequestBody, + Response, } from "./paths"; export type { Reference } from "./references"; @@ -97,12 +97,7 @@ export type { Discriminator, Schema } from "./schema"; * @see {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object | OpenAPI 3.1.1 OAuth Flow Object} * @see {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object | OpenAPI 3.1.1 Security Requirement Object} */ -export type { - OAuthFlow, - OAuthFlows, - SecurityRequirement, - SecurityScheme, -} from "./security"; +export type { OAuthFlow, OAuthFlows, SecurityRequirement, SecurityScheme } from "./security"; /** * Server configuration types. * diff --git a/3.1/info.ts b/3.1/info.ts index eaecfdb..4bd676e 100644 --- a/3.1/info.ts +++ b/3.1/info.ts @@ -62,59 +62,59 @@ import type { Extension } from "./extensions"; * ``` */ export interface Info extends Extension { - /** - * The title of the API. This field is required. - * - * @example "Pet Store API" - * @example "User Management API" - */ - title: string; + /** + * The title of the API. This field is required. + * + * @example "Pet Store API" + * @example "User Management API" + */ + title: string; - /** - * A short summary of the API. - * - * @example "A sample API that uses a petstore as an example" - * @example "API for managing users and their data" - */ - summary?: string; + /** + * A short summary of the API. + * + * @example "A sample API that uses a petstore as an example" + * @example "API for managing users and their data" + */ + summary?: string; - /** - * A description of the API. CommonMark syntax MAY be used for rich text representation. - * - * @example "This is a sample server Petstore server." - * @example "This API provides endpoints for user management, authentication, and data operations." - */ - description?: string; + /** + * A description of the API. CommonMark syntax MAY be used for rich text representation. + * + * @example "This is a sample server Petstore server." + * @example "This API provides endpoints for user management, authentication, and data operations." + */ + description?: string; - /** - * A URL to the Terms of Service for the API. MUST be in the format of a URL. - * - * @example "http://example.com/terms/" - * @example "https://www.example.com/terms-of-service" - */ - termsOfService?: string; + /** + * A URL to the Terms of Service for the API. MUST be in the format of a URL. + * + * @example "http://example.com/terms/" + * @example "https://www.example.com/terms-of-service" + */ + termsOfService?: string; - /** - * The contact information for the exposed API. - * - * @example { name: "API Support", email: "support@example.com" } - */ - contact?: Contact; + /** + * The contact information for the exposed API. + * + * @example { name: "API Support", email: "support@example.com" } + */ + contact?: Contact; - /** - * The license information for the exposed API. - * - * @example { name: "Apache 2.0", url: "https://www.apache.org/licenses/LICENSE-2.0.html" } - */ - license?: License; + /** + * The license information for the exposed API. + * + * @example { name: "Apache 2.0", url: "https://www.apache.org/licenses/LICENSE-2.0.html" } + */ + license?: License; - /** - * The version of the OpenAPI document. This field is required. - * - * @example "1.0.0" - * @example "2.1.3" - */ - version: string; + /** + * The version of the OpenAPI document. This field is required. + * + * @example "1.0.0" + * @example "2.1.3" + */ + version: string; } /** @@ -163,29 +163,29 @@ export interface Info extends Extension { * ``` */ export interface Contact extends Extension { - /** - * The identifying name of the contact person/organization. - * - * @example "API Support" - * @example "Development Team" - */ - name?: string; + /** + * The identifying name of the contact person/organization. + * + * @example "API Support" + * @example "Development Team" + */ + name?: string; - /** - * The URL pointing to the contact information. MUST be in the format of a URL. - * - * @example "http://www.example.com/support" - * @example "https://example.com/contact" - */ - url?: string; + /** + * The URL pointing to the contact information. MUST be in the format of a URL. + * + * @example "http://www.example.com/support" + * @example "https://example.com/contact" + */ + url?: string; - /** - * The email address of the contact person/organization. MUST be in the format of an email address. - * - * @example "support@example.com" - * @example "dev@example.com" - */ - email?: string; + /** + * The email address of the contact person/organization. MUST be in the format of an email address. + * + * @example "support@example.com" + * @example "dev@example.com" + */ + email?: string; } /** @@ -233,31 +233,31 @@ export interface Contact extends Extension { * ``` */ export interface License extends Extension { - /** - * The license name used for the API. This field is required. - * - * @example "Apache 2.0" - * @example "MIT" - * @example "GPL-3.0" - */ - name: string; + /** + * The license name used for the API. This field is required. + * + * @example "Apache 2.0" + * @example "MIT" + * @example "GPL-3.0" + */ + name: string; - /** - * An SPDX license expression for the API. The `identifier` field is mutually - * exclusive of the `url` field. - * - * @example "Apache-2.0" - * @example "MIT" - * @example "GPL-3.0" - */ - identifier?: string; + /** + * An SPDX license expression for the API. The `identifier` field is mutually + * exclusive of the `url` field. + * + * @example "Apache-2.0" + * @example "MIT" + * @example "GPL-3.0" + */ + identifier?: string; - /** - * A URL to the license used for the API. MUST be in the format of a URL. - * The `url` field is mutually exclusive of the `identifier` field. - * - * @example "https://www.apache.org/licenses/LICENSE-2.0.html" - * @example "https://opensource.org/licenses/MIT" - */ - url?: string; + /** + * A URL to the license used for the API. MUST be in the format of a URL. + * The `url` field is mutually exclusive of the `identifier` field. + * + * @example "https://www.apache.org/licenses/LICENSE-2.0.html" + * @example "https://opensource.org/licenses/MIT" + */ + url?: string; } diff --git a/3.1/paths.ts b/3.1/paths.ts index 16c0f09..146d372 100644 --- a/3.1/paths.ts +++ b/3.1/paths.ts @@ -106,79 +106,79 @@ export type Paths = Record; * ``` */ export interface PathItem extends Extension { - /** - * An optional, string summary, intended to apply to all operations in this path. - * - * @example "Pet operations" - * @example "User management" - */ - summary?: string; + /** + * An optional, string summary, intended to apply to all operations in this path. + * + * @example "Pet operations" + * @example "User management" + */ + summary?: string; - /** - * An optional, string description, intended to apply to all operations in this path. - * CommonMark syntax MAY be used for rich text representation. - * - * @example "Operations related to pet management" - * @example "All user-related operations" - */ - description?: string; + /** + * An optional, string description, intended to apply to all operations in this path. + * CommonMark syntax MAY be used for rich text representation. + * + * @example "Operations related to pet management" + * @example "All user-related operations" + */ + description?: string; - /** - * A definition of a GET operation on this path. - */ - get?: Operation; + /** + * A definition of a GET operation on this path. + */ + get?: Operation; - /** - * A definition of a PUT operation on this path. - */ - put?: Operation; + /** + * A definition of a PUT operation on this path. + */ + put?: Operation; - /** - * A definition of a POST operation on this path. - */ - post?: Operation; + /** + * A definition of a POST operation on this path. + */ + post?: Operation; - /** - * A definition of a DELETE operation on this path. - */ - delete?: Operation; + /** + * A definition of a DELETE operation on this path. + */ + delete?: Operation; - /** - * A definition of an OPTIONS operation on this path. - */ - options?: Operation; + /** + * A definition of an OPTIONS operation on this path. + */ + options?: Operation; - /** - * A definition of a HEAD operation on this path. - */ - head?: Operation; + /** + * A definition of a HEAD operation on this path. + */ + head?: Operation; - /** - * A definition of a PATCH operation on this path. - */ - patch?: Operation; + /** + * A definition of a PATCH operation on this path. + */ + patch?: Operation; - /** - * A definition of a TRACE operation on this path. - */ - trace?: Operation; + /** + * A definition of a TRACE operation on this path. + */ + trace?: Operation; - /** - * An alternative server array to service all operations in this path. - * - * @example [{ url: "https://api.example.com/v1" }] - */ - servers?: Server[]; + /** + * An alternative server array to service all operations in this path. + * + * @example [{ url: "https://api.example.com/v1" }] + */ + servers?: Server[]; - /** - * 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. - * - * @example [{ name: "id", in: "path", required: true, schema: { type: "string" } }] - */ - parameters?: (Parameter | Reference)[]; + /** + * 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. + * + * @example [{ name: "id", in: "path", required: true, schema: { type: "string" } }] + */ + parameters?: (Parameter | Reference)[]; } /** @@ -231,112 +231,112 @@ export interface PathItem extends Extension { * ``` */ export interface Operation extends Extension { - /** - * A list of tags for API documentation control. Tags can be used for logical - * grouping of operations by resources or any other qualifier. - * - * @example ["pets", "list"] - * @example ["users", "authentication"] - */ - tags?: string[]; + /** + * A list of tags for API documentation control. Tags can be used for logical + * grouping of operations by resources or any other qualifier. + * + * @example ["pets", "list"] + * @example ["users", "authentication"] + */ + tags?: string[]; - /** - * A short summary of what the operation does. - * - * @example "List all pets" - * @example "Create a new user" - */ - summary?: string; + /** + * A short summary of what the operation does. + * + * @example "List all pets" + * @example "Create a new user" + */ + summary?: string; - /** - * A verbose explanation of the operation behavior. CommonMark syntax MAY be used - * for rich text representation. - * - * @example "Returns all pets from the system that the user has access to" - * @example "Creates a new user account with the provided information" - */ - description?: string; + /** + * A verbose explanation of the operation behavior. CommonMark syntax MAY be used + * for rich text representation. + * + * @example "Returns all pets from the system that the user has access to" + * @example "Creates a new user account with the provided information" + */ + description?: string; - /** - * Additional external documentation for this operation. - * - * @example { description: "Find out more about pet operations", url: "https://example.com/docs/pets" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for this operation. + * + * @example { description: "Find out more about pet operations", url: "https://example.com/docs/pets" } + */ + externalDocs?: ExternalDocumentation; - /** - * Unique string used to identify the operation. The id MUST be unique among all - * operations described in the API. The operationId value is case-sensitive. - * - * @example "listPets" - * @example "createUser" - */ - operationId?: string; + /** + * Unique string used to identify the operation. The id MUST be unique among all + * operations described in the API. The operationId value is case-sensitive. + * + * @example "listPets" + * @example "createUser" + */ + operationId?: string; - /** - * A list of parameters that are applicable for this operation. If a parameter - * is already defined at the Path Item, the new definition will override it but - * can never remove it. The list MUST NOT include duplicated parameters. - * - * @example [{ name: "limit", in: "query", schema: { type: "integer" } }] - */ - parameters?: (Parameter | Reference)[]; + /** + * A list of parameters that are applicable for this operation. If a parameter + * is already defined at the Path Item, the new definition will override it but + * can never remove it. The list MUST NOT include duplicated parameters. + * + * @example [{ name: "limit", in: "query", schema: { type: "integer" } }] + */ + parameters?: (Parameter | Reference)[]; - /** - * 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. - * - * @example { description: "Pet to add to the store", content: { "application/json": { schema: { $ref: "#/components/schemas/Pet" } } } } - */ - requestBody?: RequestBody | Reference; + /** + * 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. + * + * @example { description: "Pet to add to the store", content: { "application/json": { schema: { $ref: "#/components/schemas/Pet" } } } } + */ + requestBody?: RequestBody | Reference; - /** - * The list of possible responses as they are returned from executing this operation. - * This field is required. - * - * @example { "200": { description: "A list of pets" }, "default": { description: "Unexpected error" } } - */ - responses: ResponsesMap; + /** + * The list of possible responses as they are returned from executing this operation. + * This field is required. + * + * @example { "200": { description: "A list of pets" }, "default": { description: "Unexpected error" } } + */ + responses: ResponsesMap; - /** - * A map of possible out-of band callbacks related to the parent operation. 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. - * - * @example { "myCallback": { "{$request.body#/callbackUrl}": { post: { requestBody: { description: "Callback payload" } } } } } - */ - callbacks?: Record; + /** + * A map of possible out-of band callbacks related to the parent operation. 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. + * + * @example { "myCallback": { "{$request.body#/callbackUrl}": { post: { requestBody: { description: "Callback payload" } } } } } + */ + callbacks?: Record; - /** - * Declares this operation to be deprecated. Consumers SHOULD refrain from using - * the declared operation. Default value is false. - * - * @example true - * @example false - * @default false - */ - deprecated?: boolean; + /** + * Declares this operation to be deprecated. Consumers SHOULD refrain from using + * the declared operation. Default value is false. + * + * @example true + * @example false + * @default false + */ + deprecated?: boolean; - /** - * A declaration of which security mechanisms can be used for this operation. - * The list of values includes alternative security requirement objects that can - * be used. Only one of the security requirement objects need to be satisfied - * to authorize a request. - * - * @example [{ "petstore_auth": ["write:pets", "read:pets"] }] - */ - security?: SecurityRequirement[]; + /** + * A declaration of which security mechanisms can be used for this operation. + * The list of values includes alternative security requirement objects that can + * be used. Only one of the security requirement objects need to be satisfied + * to authorize a request. + * + * @example [{ "petstore_auth": ["write:pets", "read:pets"] }] + */ + security?: SecurityRequirement[]; - /** - * An alternative server array to service this operation. If an alternative - * server object is specified at the Path Item Object level, it will be - * overridden by this value. - * - * @example [{ url: "https://api.example.com/v1" }] - */ - servers?: Server[]; + /** + * An alternative server array to service this operation. If an alternative + * server object is specified at the Path Item Object level, it will be + * overridden by this value. + * + * @example [{ url: "https://api.example.com/v1" }] + */ + servers?: Server[]; } /** @@ -391,42 +391,42 @@ export interface Operation extends Extension { * ``` */ export interface Example extends Extension { - /** - * Short description for the example. - * - * @example "A user example" - * @example "Error response example" - */ - summary?: string; + /** + * Short description for the example. + * + * @example "A user example" + * @example "Error response example" + */ + summary?: string; - /** - * Long description for the example. CommonMark syntax MAY be used for rich text representation. - * - * @example "This example shows a typical user object with all required fields" - * @example "This example demonstrates an error response when validation fails" - */ - description?: string; + /** + * Long description for the example. CommonMark syntax MAY be used for rich text representation. + * + * @example "This example shows a typical user object with all required fields" + * @example "This example demonstrates an error response when validation fails" + */ + description?: string; - /** - * Embedded literal example. The value field and externalValue field are mutually exclusive. - * To represent examples of media types that cannot naturally represented in JSON or YAML, - * use a string value to contain the example, escaping where necessary. - * - * @example { id: 1, name: "John Doe" } - * @example "example string" - * @example 42 - */ - value?: unknown; + /** + * Embedded literal example. The value field and externalValue field are mutually exclusive. + * To represent examples of media types that cannot naturally represented in JSON or YAML, + * use a string value to contain the example, escaping where necessary. + * + * @example { id: 1, name: "John Doe" } + * @example "example string" + * @example 42 + */ + value?: unknown; - /** - * A URI 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. - * - * @example "https://example.com/examples/user-example.json" - * @example "https://example.com/examples/error-example.xml" - */ - externalValue?: string; + /** + * A URI 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. + * + * @example "https://example.com/examples/user-example.json" + * @example "https://example.com/examples/error-example.xml" + */ + externalValue?: string; } /** @@ -491,137 +491,137 @@ export interface Example extends Extension { * ``` */ export interface Parameter extends Extension { - /** - * The name of the parameter. Parameter names are case sensitive. - * - * @example "userId" - * @example "limit" - * @example "X-API-Key" - */ - name: string; + /** + * The name of the parameter. Parameter names are case sensitive. + * + * @example "userId" + * @example "limit" + * @example "X-API-Key" + */ + name: string; - /** - * The location of the parameter. Possible values are "query", "header", "path" or "cookie". - * - * @example "query" - * @example "path" - * @example "header" - * @example "cookie" - */ - in: "query" | "header" | "path" | "cookie"; + /** + * The location of the parameter. Possible values are "query", "header", "path" or "cookie". + * + * @example "query" + * @example "path" + * @example "header" + * @example "cookie" + */ + in: "query" | "header" | "path" | "cookie"; - /** - * A brief description of the parameter. This could contain examples of use. - * CommonMark syntax MAY be used for rich text representation. - * - * @example "The user ID to retrieve" - * @example "Maximum number of items to return" - */ - description?: string; + /** + * A brief description of the parameter. This could contain examples of use. + * CommonMark syntax MAY be used for rich text representation. + * + * @example "The user ID to retrieve" + * @example "Maximum number of items to return" + */ + description?: string; - /** - * 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. - * - * @example true - * @example false - */ - required?: boolean; + /** + * 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. + * + * @example true + * @example false + */ + required?: boolean; - /** - * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. - * Default value is false. - * - * @example true - * @example false - */ - deprecated?: boolean; + /** + * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. + * Default value is false. + * + * @example true + * @example false + */ + deprecated?: boolean; - /** - * Sets the ability to pass empty-valued parameters. This is valid only for query - * parameters and allows sending a parameter with an empty value. Default value is false. - * - * @example true - * @example false - */ - allowEmptyValue?: boolean; + /** + * Sets the ability to pass empty-valued parameters. This is valid only for query + * parameters and allows sending a parameter with an empty value. Default value is false. + * + * @example true + * @example false + */ + allowEmptyValue?: boolean; - /** - * 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. - * - * @example "simple" - * @example "form" - * @example "matrix" - * @example "label" - * @example "spaceDelimited" - * @example "pipeDelimited" - * @example "deepObject" - */ - style?: string; + /** + * Describes how the parameter value will be serialized depending on the type of the + * parameter value. Default values (based on value of in): for query - form; for path - simple; + * for header - simple; for cookie - form. + * + * @example "simple" + * @example "form" + * @example "matrix" + * @example "label" + * @example "spaceDelimited" + * @example "pipeDelimited" + * @example "deepObject" + */ + style?: string; - /** - * 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. - * - * @example true - * @example false - */ - explode?: boolean; + /** + * 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. + * + * @example true + * @example false + */ + explode?: boolean; - /** - * 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. - * - * @example true - * @example false - */ - allowReserved?: boolean; + /** + * 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. + * + * @example true + * @example false + */ + allowReserved?: boolean; - /** - * The schema defining the type used for the parameter. This field is mutually exclusive - * with the content field. - * - * @example { type: "string" } - * @example { type: "integer", minimum: 1 } - */ - schema?: Schema; + /** + * The schema defining the type used for the parameter. This field is mutually exclusive + * with the content field. + * + * @example { type: "string" } + * @example { type: "integer", minimum: 1 } + */ + schema?: Schema; - /** - * Example of the parameter's potential value. The example SHOULD match the specified - * schema and encoding properties if present. The example field is mutually exclusive - * of the examples field. Furthermore, if referencing a schema that contains an example, - * the example value SHALL override the example provided by the schema. - * - * @example "example value" - * @example 42 - * @example { id: 1, name: "John" } - */ - example?: unknown; + /** + * Example of the parameter's potential value. The example SHOULD match the specified + * schema and encoding properties if present. The example field is mutually exclusive + * of the examples field. Furthermore, if referencing a schema that contains an example, + * the example value SHALL override the example provided by the schema. + * + * @example "example value" + * @example 42 + * @example { id: 1, name: "John" } + */ + example?: unknown; - /** - * Examples of the parameter's potential value. Each example SHOULD contain a value in - * the correct format as specified in the parameter encoding. The examples field is - * mutually exclusive of the example field. Furthermore, if referencing a schema that - * contains an example, the examples value SHALL override the example provided by the schema. - * - * @example { "user1": { summary: "A user example", value: { id: 1, name: "John" } } } - */ - examples?: Record; + /** + * Examples of the parameter's potential value. Each example SHOULD contain a value in + * the correct format as specified in the parameter encoding. The examples field is + * mutually exclusive of the example field. Furthermore, if referencing a schema that + * contains an example, the examples value SHALL override the example provided by the schema. + * + * @example { "user1": { summary: "A user example", value: { id: 1, name: "John" } } } + */ + examples?: Record; - /** - * 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. This field is - * mutually exclusive with the schema field. - * - * @example { "application/json": { schema: { type: "string" } } } - */ - content?: Record; + /** + * 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. This field is + * mutually exclusive with the schema field. + * + * @example { "application/json": { schema: { type: "string" } } } + */ + content?: Record; } /** @@ -685,32 +685,32 @@ export interface Parameter extends Extension { * ``` */ export interface RequestBody extends Extension { - /** - * A brief description of the request body. This could contain examples of use. - * CommonMark syntax MAY be used for rich text representation. - * - * @example "User data to create" - * @example "File upload with metadata" - */ - description?: string; + /** + * A brief description of the request body. This could contain examples of use. + * CommonMark syntax MAY be used for rich text representation. + * + * @example "User data to create" + * @example "File upload with metadata" + */ + description?: string; - /** - * The content of the request body. The key is a media type or media type range and - * the value describes it. For request bodies that are sent using multipart/form-data, - * the encoding property is used to describe the encoding of the request body. - * - * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } - * @example { "multipart/form-data": { schema: { type: "object", properties: { file: { type: "string", format: "binary" } } } } } - */ - content: Record; + /** + * The content of the request body. The key is a media type or media type range and + * the value describes it. For request bodies that are sent using multipart/form-data, + * the encoding property is used to describe the encoding of the request body. + * + * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } + * @example { "multipart/form-data": { schema: { type: "object", properties: { file: { type: "string", format: "binary" } } } } } + */ + content: Record; - /** - * Determines if the request body is required in the request. Defaults to false. - * - * @example true - * @example false - */ - required?: boolean; + /** + * Determines if the request body is required in the request. Defaults to false. + * + * @example true + * @example false + */ + required?: boolean; } /** @@ -774,42 +774,42 @@ export interface RequestBody extends Extension { * ``` */ export interface Response extends Extension { - /** - * A short description of the response. CommonMark syntax MAY be used for rich text representation. - * This field is required. - * - * @example "A list of users" - * @example "User created successfully" - * @example "Bad request - validation failed" - */ - description: string; + /** + * A short description of the response. CommonMark syntax MAY be used for rich text representation. + * This field is required. + * + * @example "A list of users" + * @example "User created successfully" + * @example "Bad request - validation failed" + */ + description: string; - /** - * 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. - * - * @example { "X-RateLimit-Limit": { description: "Rate limit per hour", schema: { type: "integer" } } } - */ - headers?: Record; + /** + * 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. + * + * @example { "X-RateLimit-Limit": { description: "Rate limit per hour", schema: { type: "integer" } } } + */ + headers?: Record; - /** - * 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/* - * - * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } - * @example { "application/json": { schema: { type: "array", items: { $ref: "#/components/schemas/User" } } } } - */ - content?: Record; + /** + * 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/* + * + * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } + * @example { "application/json": { schema: { type: "array", items: { $ref: "#/components/schemas/User" } } } } + */ + content?: Record; - /** - * 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. - * - * @example { "GetUser": { operationId: "getUserById", parameters: { userId: "$response.body#/id" } } } - */ - links?: Record; + /** + * 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. + * + * @example { "GetUser": { operationId: "getUserById", parameters: { userId: "$response.body#/id" } } } + */ + links?: Record; } /** @@ -874,106 +874,106 @@ export interface Response extends Extension { * ``` */ export interface Header extends Extension { - /** - * A brief description of the header. This could contain examples of use. - * CommonMark syntax MAY be used for rich text representation. - * - * @example "Rate limit per hour" - * @example "Custom authentication token" - */ - description?: string; + /** + * A brief description of the header. This could contain examples of use. + * CommonMark syntax MAY be used for rich text representation. + * + * @example "Rate limit per hour" + * @example "Custom authentication token" + */ + description?: string; - /** - * Determines whether this header is mandatory. The property MAY be included and its - * default value is false. - * - * @example true - * @example false - */ - required?: boolean; + /** + * Determines whether this header is mandatory. The property MAY be included and its + * default value is false. + * + * @example true + * @example false + */ + required?: boolean; - /** - * Specifies that a header is deprecated and SHOULD be transitioned out of usage. - * Default value is false. - * - * @example true - * @example false - */ - deprecated?: boolean; + /** + * Specifies that a header is deprecated and SHOULD be transitioned out of usage. + * Default value is false. + * + * @example true + * @example false + */ + deprecated?: boolean; - /** - * Sets the ability to pass empty-valued headers. This is valid only for headers - * and allows sending a header with an empty value. Default value is false. - * - * @example true - * @example false - */ - allowEmptyValue?: boolean; + /** + * Sets the ability to pass empty-valued headers. This is valid only for headers + * and allows sending a header with an empty value. Default value is false. + * + * @example true + * @example false + */ + allowEmptyValue?: boolean; - /** - * Describes how the header value will be serialized. The default value is "simple". - * - * @example "simple" - * @example "form" - */ - style?: string; + /** + * Describes how the header value will be serialized. The default value is "simple". + * + * @example "simple" + * @example "form" + */ + style?: string; - /** - * When this is true, header values of type array or object generate separate headers - * for each value of the array or key-value pair of the map. For other types of headers - * this property has no effect. When style is form, the default value is true. For all other - * styles, the default value is false. - * - * @example true - * @example false - */ - explode?: boolean; + /** + * When this is true, header values of type array or object generate separate headers + * for each value of the array or key-value pair of the map. For other types of headers + * this property has no effect. When style is form, the default value is true. For all other + * styles, the default value is false. + * + * @example true + * @example false + */ + explode?: boolean; - /** - * Determines whether the header value SHOULD allow reserved characters, as defined by - * RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. - * - * @example true - * @example false - */ - allowReserved?: boolean; + /** + * Determines whether the header value SHOULD allow reserved characters, as defined by + * RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. + * + * @example true + * @example false + */ + allowReserved?: boolean; - /** - * The schema defining the type used for the header. This field is mutually exclusive - * with the content field. - * - * @example { type: "string" } - * @example { type: "integer", minimum: 0 } - */ - schema?: Schema; + /** + * The schema defining the type used for the header. This field is mutually exclusive + * with the content field. + * + * @example { type: "string" } + * @example { type: "integer", minimum: 0 } + */ + schema?: Schema; - /** - * Example of the header's potential value. The example SHOULD match the specified - * schema and encoding properties if present. The example field is mutually exclusive - * of the examples field. - * - * @example "example value" - * @example 42 - */ - example?: unknown; + /** + * Example of the header's potential value. The example SHOULD match the specified + * schema and encoding properties if present. The example field is mutually exclusive + * of the examples field. + * + * @example "example value" + * @example 42 + */ + example?: unknown; - /** - * Examples of the header's potential value. Each example SHOULD contain a value in - * the correct format as specified in the header encoding. The examples field is - * mutually exclusive of the example field. - * - * @example { "header1": { summary: "A header example", value: "example value" } } - */ - examples?: Record; + /** + * Examples of the header's potential value. Each example SHOULD contain a value in + * the correct format as specified in the header encoding. The examples field is + * mutually exclusive of the example field. + * + * @example { "header1": { summary: "A header example", value: "example value" } } + */ + examples?: Record; - /** - * A map containing the representations for the header. The key is the media type - * and the value describes it. The map MUST only contain one entry. This field is - * mutually exclusive with the schema field. - * - * @example { "application/json": { schema: { type: "string" } } } - */ - content?: Record; + /** + * A map containing the representations for the header. The key is the media type + * and the value describes it. The map MUST only contain one entry. This field is + * mutually exclusive with the schema field. + * + * @example { "application/json": { schema: { type: "string" } } } + */ + content?: Record; } /** @@ -1032,44 +1032,44 @@ export interface Header extends Extension { * ``` */ export interface MediaType extends Extension { - /** - * The schema defining the content of the request, response, or parameter. - * - * @example { $ref: "#/components/schemas/User" } - * @example { type: "array", items: { type: "string" } } - */ - schema?: Schema; + /** + * The schema defining the content of the request, response, or parameter. + * + * @example { $ref: "#/components/schemas/User" } + * @example { type: "array", items: { type: "string" } } + */ + schema?: Schema; - /** - * Example of the media type. The example SHOULD match the specified schema and encoding - * properties if present. The example field is mutually exclusive of the examples field. - * Furthermore, if referencing a schema that contains an example, the example value - * SHALL override the example provided by the schema. - * - * @example { id: 1, name: "John Doe" } - * @example "example string" - * @example 42 - */ - example?: unknown; + /** + * Example of the media type. The example SHOULD match the specified schema and encoding + * properties if present. The example field is mutually exclusive of the examples field. + * Furthermore, if referencing a schema that contains an example, the example value + * SHALL override the example provided by the schema. + * + * @example { id: 1, name: "John Doe" } + * @example "example string" + * @example 42 + */ + example?: unknown; - /** - * Examples of the media type. Each example SHOULD contain a value in the correct format - * as specified in the media type encoding. The examples field is mutually exclusive - * of the example field. Furthermore, if referencing a schema that contains an example, - * the examples value SHALL override the example provided by the schema. - * - * @example { "user1": { summary: "A user example", value: { id: 1, name: "John" } } } - */ - examples?: Record; + /** + * Examples of the media type. Each example SHOULD contain a value in the correct format + * as specified in the media type encoding. The examples field is mutually exclusive + * of the example field. Furthermore, if referencing a schema that contains an example, + * the examples value SHALL override the example provided by the schema. + * + * @example { "user1": { summary: "A user example", value: { id: 1, name: "John" } } } + */ + examples?: Record; - /** - * 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. - * - * @example { "file": { contentType: "image/png" }, "description": { contentType: "text/plain" } } - */ - encoding?: Record; + /** + * 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. + * + * @example { "file": { contentType: "image/png" }, "description": { contentType: "text/plain" } } + */ + encoding?: Record; } /** @@ -1124,65 +1124,65 @@ export interface MediaType extends Extension { * ``` */ export interface Encoding extends Extension { - /** - * The Content-Type for encoding a specific property. Default value depends on the - * property type: for string with format being binary – application/octet-stream; - * for other primitive types – text/plain; for object – application/json; - * for array – the default is determined based on the inner type. - * - * @example "image/png" - * @example "application/json" - * @example "text/plain" - */ - contentType?: string; + /** + * The Content-Type for encoding a specific property. Default value depends on the + * property type: for string with format being binary – application/octet-stream; + * for other primitive types – text/plain; for object – application/json; + * for array – the default is determined based on the inner type. + * + * @example "image/png" + * @example "application/json" + * @example "text/plain" + */ + contentType?: string; - /** - * A map allowing additional information to be provided as headers, for example - * Content-Disposition. Content-Type is described separately and SHALL be ignored - * in this section. This property SHALL be ignored if the request body media type - * is not a multipart. - * - * @example { "Content-Disposition": { description: "File attachment", schema: { type: "string" } } } - */ - headers?: Record; + /** + * A map allowing additional information to be provided as headers, for example + * Content-Disposition. Content-Type is described separately and SHALL be ignored + * in this section. This property SHALL be ignored if the request body media type + * is not a multipart. + * + * @example { "Content-Disposition": { description: "File attachment", schema: { type: "string" } } } + */ + headers?: Record; - /** - * Describes how a specific property value will be serialized depending on its type. - * See Parameter Object for details on the style property. The behavior follows the - * same values as query parameters, including default values. This property SHALL be - * ignored if the request body media type is not application/x-www-form-urlencoded - * or multipart/form-data. - * - * @example "form" - * @example "spaceDelimited" - * @example "pipeDelimited" - * @example "deepObject" - */ - style?: string; + /** + * Describes how a specific property value will be serialized depending on its type. + * See Parameter Object for details on the style property. The behavior follows the + * same values as query parameters, including default values. This property SHALL be + * ignored if the request body media type is not application/x-www-form-urlencoded + * or multipart/form-data. + * + * @example "form" + * @example "spaceDelimited" + * @example "pipeDelimited" + * @example "deepObject" + */ + style?: string; - /** - * When this is true, property 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 properties this property has no effect. When style is form, the default - * value is true. For all other styles, the default value is false. This property - * SHALL be ignored if the request body media type is not application/x-www-form-urlencoded - * or multipart/form-data. - * - * @example true - * @example false - */ - explode?: boolean; + /** + * When this is true, property 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 properties this property has no effect. When style is form, the default + * value is true. For all other styles, the default value is false. This property + * SHALL be ignored if the request body media type is not application/x-www-form-urlencoded + * or multipart/form-data. + * + * @example true + * @example false + */ + explode?: boolean; - /** - * Determines whether the parameter value SHOULD allow reserved characters, as defined - * by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default - * value is false. This property SHALL be ignored if the request body media type is - * not application/x-www-form-urlencoded. - * - * @example true - * @example false - */ - allowReserved?: boolean; + /** + * Determines whether the parameter value SHOULD allow reserved characters, as defined + * by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default + * value is false. This property SHALL be ignored if the request body media type is + * not application/x-www-form-urlencoded. + * + * @example true + * @example false + */ + allowReserved?: boolean; } /** @@ -1240,59 +1240,59 @@ export interface Encoding extends Extension { * ``` */ export interface Link extends Extension { - /** - * A relative or absolute reference to an OAS operation. This field is mutually exclusive - * of the operationId field, and MUST point to an Operation Object. Relative operationRef - * values MAY be used to locate an existing Operation Object in the OpenAPI definition. - * - * @example "#/paths/~1users~1{userId}/get" - * @example "https://example.com/openapi.json#/paths/~1users~1{userId}/get" - */ - operationRef?: string; + /** + * A relative or absolute reference to an OAS operation. This field is mutually exclusive + * of the operationId field, and MUST point to an Operation Object. Relative operationRef + * values MAY be used to locate an existing Operation Object in the OpenAPI definition. + * + * @example "#/paths/~1users~1{userId}/get" + * @example "https://example.com/openapi.json#/paths/~1users~1{userId}/get" + */ + operationRef?: string; - /** - * The name of an existing, resolvable OAS operation, as defined with a unique operationId. - * This field is mutually exclusive of the operationRef field. - * - * @example "getUserById" - * @example "createUser" - */ - operationId?: string; + /** + * The name of an existing, resolvable OAS operation, as defined with a unique operationId. + * This field is mutually exclusive of the operationRef field. + * + * @example "getUserById" + * @example "createUser" + */ + operationId?: string; - /** - * A map representing parameters to pass to an operation as specified with operationId - * or identified via operationRef. The key is the parameter name to be used, whereas - * the value can be a constant or an expression to be evaluated and passed to the linked - * operation. The parameter name can be qualified using the parameter location [{in}.]{name} - * for operations that use the same parameter name in different locations (e.g. path.id). - * - * @example { "userId": "$response.body#/id" } - * @example { "path.id": "$response.body#/id", "query.limit": 10 } - */ - parameters?: Record; + /** + * A map representing parameters to pass to an operation as specified with operationId + * or identified via operationRef. The key is the parameter name to be used, whereas + * the value can be a constant or an expression to be evaluated and passed to the linked + * operation. The parameter name can be qualified using the parameter location [{in}.]{name} + * for operations that use the same parameter name in different locations (e.g. path.id). + * + * @example { "userId": "$response.body#/id" } + * @example { "path.id": "$response.body#/id", "query.limit": 10 } + */ + parameters?: Record; - /** - * A literal value or expression to use as a request body when calling the target operation. - * - * @example { "name": "John Doe", "email": "john@example.com" } - * @example "$request.body" - */ - requestBody?: unknown; + /** + * A literal value or expression to use as a request body when calling the target operation. + * + * @example { "name": "John Doe", "email": "john@example.com" } + * @example "$request.body" + */ + requestBody?: unknown; - /** - * A description of the link. CommonMark syntax MAY be used for rich text representation. - * - * @example "Get the user by ID" - * @example "Create a new user with the provided data" - */ - description?: string; + /** + * A description of the link. CommonMark syntax MAY be used for rich text representation. + * + * @example "Get the user by ID" + * @example "Create a new user with the provided data" + */ + description?: string; - /** - * A server object to be used by the target operation. - * - * @example { url: "https://api.example.com/v1" } - */ - server?: Server; + /** + * A server object to be used by the target operation. + * + * @example { url: "https://api.example.com/v1" } + */ + server?: Server; } /** @@ -1364,14 +1364,14 @@ export interface Link extends Extension { * ``` */ export interface Callback { - /** - * A runtime expression that identifies a URL to use for the callback operation. - * The expression is evaluated at runtime and MUST resolve to a URL. The value - * is a Path Item Object that describes the callback operations. - * - * @example "{$request.body#/callbackUrl}" - * @example "{$request.body#/webhookUrl}" - * @example "{$request.body#/notificationUrl}" - */ - [expression: string]: PathItem | Reference; + /** + * A runtime expression that identifies a URL to use for the callback operation. + * The expression is evaluated at runtime and MUST resolve to a URL. The value + * is a Path Item Object that describes the callback operations. + * + * @example "{$request.body#/callbackUrl}" + * @example "{$request.body#/webhookUrl}" + * @example "{$request.body#/notificationUrl}" + */ + [expression: string]: PathItem | Reference; } diff --git a/3.1/references.ts b/3.1/references.ts index aa4c131..5658888 100644 --- a/3.1/references.ts +++ b/3.1/references.ts @@ -55,31 +55,31 @@ * ``` */ export interface Reference { - /** - * The reference string. This field is required and must be a valid JSON Reference. - * It can reference internal components using `#/` or external resources using URLs. - * - * @example "#/components/schemas/User" - * @example "#/components/responses/NotFound" - * @example "https://example.com/schemas/User.json" - */ - $ref: string; + /** + * The reference string. This field is required and must be a valid JSON Reference. + * It can reference internal components using `#/` or external resources using URLs. + * + * @example "#/components/schemas/User" + * @example "#/components/responses/NotFound" + * @example "https://example.com/schemas/User.json" + */ + $ref: string; - /** - * A description of the referenced object. This can be used to provide - * additional context about what the referenced object represents. - * - * @example "A user object containing user information" - * @example "Standard error response for not found resources" - */ - description?: string; + /** + * A description of the referenced object. This can be used to provide + * additional context about what the referenced object represents. + * + * @example "A user object containing user information" + * @example "Standard error response for not found resources" + */ + description?: string; - /** - * A short summary of the referenced object. This can be used to provide - * a brief overview of what the referenced object represents. - * - * @example "User schema" - * @example "Not found response" - */ - summary?: string; + /** + * A short summary of the referenced object. This can be used to provide + * a brief overview of what the referenced object represents. + * + * @example "User schema" + * @example "Not found response" + */ + summary?: string; } diff --git a/3.1/schema.ts b/3.1/schema.ts index 7dcec7c..ffcfb13 100644 --- a/3.1/schema.ts +++ b/3.1/schema.ts @@ -1,13 +1,13 @@ import type { - ArraySchema, - BooleanSchema, - CompositionSchema, - IntegerSchema, - NullSchema, - NumberSchema, - ObjectSchema, - ReferenceSchema, - StringSchema, + ArraySchema, + BooleanSchema, + CompositionSchema, + IntegerSchema, + NullSchema, + NumberSchema, + ObjectSchema, + ReferenceSchema, + StringSchema, } from "./data-types"; import type { Extension } from "./extensions"; @@ -58,21 +58,21 @@ import type { Extension } from "./extensions"; * ``` */ export interface Discriminator extends Extension { - /** - * The name of the property in the payload that will hold the discriminator value. - * This property must be present in the payload. - * - * Example: `"petType"` - */ - propertyName: string; + /** + * The name of the property in the payload that will hold the discriminator value. + * This property must be present in the payload. + * + * Example: `"petType"` + */ + propertyName: string; - /** - * An object to hold mappings between payload values and schema names or references. - * If not provided, the schema name will be used as the discriminator value. - * - * Example: `{ dog: "#/components/schemas/Dog", cat: "#/components/schemas/Cat" }` - */ - mapping?: Record; + /** + * An object to hold mappings between payload values and schema names or references. + * If not provided, the schema name will be used as the discriminator value. + * + * Example: `{ dog: "#/components/schemas/Dog", cat: "#/components/schemas/Cat" }` + */ + mapping?: Record; } /** @@ -243,12 +243,12 @@ export interface Discriminator extends Extension { * ``` */ export type Schema = - | ReferenceSchema - | StringSchema - | NumberSchema - | IntegerSchema - | BooleanSchema - | ArraySchema - | ObjectSchema - | NullSchema - | CompositionSchema; + | ReferenceSchema + | StringSchema + | NumberSchema + | IntegerSchema + | BooleanSchema + | ArraySchema + | ObjectSchema + | NullSchema + | CompositionSchema; diff --git a/3.1/security.ts b/3.1/security.ts index 58fc389..49e8e82 100644 --- a/3.1/security.ts +++ b/3.1/security.ts @@ -79,80 +79,80 @@ import type { Extension } from "./extensions"; * ``` */ export interface SecurityScheme extends Extension { - /** - * The type of the security scheme. This field is required. - * - * @example "apiKey" - * @example "http" - * @example "mutualTLS" - * @example "oauth2" - * @example "openIdConnect" - */ - type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect"; + /** + * The type of the security scheme. This field is required. + * + * @example "apiKey" + * @example "http" + * @example "mutualTLS" + * @example "oauth2" + * @example "openIdConnect" + */ + type: "apiKey" | "http" | "mutualTLS" | "oauth2" | "openIdConnect"; - /** - * A short description for security scheme. CommonMark syntax MAY be used - * for rich text representation. - * - * @example "API key authentication" - * @example "OAuth2 authentication with authorization code flow" - */ - description?: string; + /** + * A short description for security scheme. CommonMark syntax MAY be used + * for rich text representation. + * + * @example "API key authentication" + * @example "OAuth2 authentication with authorization code flow" + */ + description?: string; - /** - * The name of the header, query or cookie parameter to be used. This field - * is required for `apiKey` type. - * - * @example "X-API-Key" - * @example "api_key" - * @example "sessionId" - */ - name?: string; + /** + * The name of the header, query or cookie parameter to be used. This field + * is required for `apiKey` type. + * + * @example "X-API-Key" + * @example "api_key" + * @example "sessionId" + */ + name?: string; - /** - * The location of the API key. This field is required for `apiKey` type. - * - * @example "header" - * @example "query" - * @example "cookie" - */ - in?: "query" | "header" | "cookie"; + /** + * The location of the API key. This field is required for `apiKey` type. + * + * @example "header" + * @example "query" + * @example "cookie" + */ + in?: "query" | "header" | "cookie"; - /** - * The name of the HTTP Authorization scheme to be used in the Authorization - * header. This field is required for `http` type. - * - * @example "basic" - * @example "bearer" - * @example "digest" - */ - scheme?: string; + /** + * The name of the HTTP Authorization scheme to be used in the Authorization + * header. This field is required for `http` type. + * + * @example "basic" + * @example "bearer" + * @example "digest" + */ + scheme?: string; - /** - * A hint to the client to identify how the bearer token is formatted. Bearer - * tokens are usually generated by an authorization server, so this information - * is primarily for documentation purposes. - * - * @example "JWT" - * @example "Bearer" - */ - bearerFormat?: string; + /** + * A hint to the client to identify how the bearer token is formatted. Bearer + * tokens are usually generated by an authorization server, so this information + * is primarily for documentation purposes. + * + * @example "JWT" + * @example "Bearer" + */ + bearerFormat?: string; - /** - * An object containing configuration information for the flow types supported. - * This field is required for `oauth2` type. - * - * @example { authorizationCode: { authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token" } } - */ - flows?: OAuthFlows; + /** + * An object containing configuration information for the flow types supported. + * This field is required for `oauth2` type. + * + * @example { authorizationCode: { authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token" } } + */ + flows?: OAuthFlows; - /** - * OpenId Connect URL to discover OAuth2 configuration values. This MUST be - * in the form of a URL. This field is required for `openIdConnect` type. - * - * @example "https://example.com/.well-known/openid_configuration" - */ - openIdConnectUrl?: string; + /** + * OpenId Connect URL to discover OAuth2 configuration values. This MUST be + * in the form of a URL. This field is required for `openIdConnect` type. + * + * @example "https://example.com/.well-known/openid_configuration" + */ + openIdConnectUrl?: string; } /** @@ -199,33 +199,33 @@ export interface SecurityScheme extends Extension { * ``` */ export interface OAuthFlows extends Extension { - /** - * Configuration for the OAuth Implicit flow. - * - * @example { authorizationUrl: "https://example.com/oauth/authorize", scopes: { "read:pets": "read your pets" } } - */ - implicit?: OAuthFlow; + /** + * Configuration for the OAuth Implicit flow. + * + * @example { authorizationUrl: "https://example.com/oauth/authorize", scopes: { "read:pets": "read your pets" } } + */ + implicit?: OAuthFlow; - /** - * Configuration for the OAuth Resource Owner Password flow. - * - * @example { tokenUrl: "https://example.com/oauth/token", scopes: { "read:pets": "read your pets" } } - */ - password?: OAuthFlow; + /** + * Configuration for the OAuth Resource Owner Password flow. + * + * @example { tokenUrl: "https://example.com/oauth/token", scopes: { "read:pets": "read your pets" } } + */ + password?: OAuthFlow; - /** - * Configuration for the OAuth Client Credentials flow. - * - * @example { tokenUrl: "https://example.com/oauth/token", scopes: { "read:pets": "read your pets" } } - */ - clientCredentials?: OAuthFlow; + /** + * Configuration for the OAuth Client Credentials flow. + * + * @example { tokenUrl: "https://example.com/oauth/token", scopes: { "read:pets": "read your pets" } } + */ + clientCredentials?: OAuthFlow; - /** - * Configuration for the OAuth Authorization Code flow. - * - * @example { authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token", scopes: { "read:pets": "read your pets" } } - */ - authorizationCode?: OAuthFlow; + /** + * Configuration for the OAuth Authorization Code flow. + * + * @example { authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token", scopes: { "read:pets": "read your pets" } } + */ + authorizationCode?: OAuthFlow; } /** @@ -270,36 +270,36 @@ export interface OAuthFlows extends Extension { * ``` */ export interface OAuthFlow extends Extension { - /** - * The authorization URL to be used for this flow. This MUST be in the form of a URL. - * This field is required for `implicit` and `authorizationCode` flows. - * - * @example "https://example.com/oauth/authorize" - */ - authorizationUrl?: string; + /** + * The authorization URL to be used for this flow. This MUST be in the form of a URL. + * This field is required for `implicit` and `authorizationCode` flows. + * + * @example "https://example.com/oauth/authorize" + */ + authorizationUrl?: string; - /** - * The token URL to be used for this flow. This MUST be in the form of a URL. - * This field is required for `password`, `clientCredentials`, and `authorizationCode` flows. - * - * @example "https://example.com/oauth/token" - */ - tokenUrl?: string; + /** + * The token URL to be used for this flow. This MUST be in the form of a URL. + * This field is required for `password`, `clientCredentials`, and `authorizationCode` flows. + * + * @example "https://example.com/oauth/token" + */ + tokenUrl?: string; - /** - * The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. - * - * @example "https://example.com/oauth/refresh" - */ - refreshUrl?: string; + /** + * The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. + * + * @example "https://example.com/oauth/refresh" + */ + refreshUrl?: string; - /** - * The available scopes for the OAuth2 security scheme. A map between the scope - * name and a short description for it. This field is required. - * - * @example { "read:pets": "read your pets", "write:pets": "modify pets in your account" } - */ - scopes: Record; + /** + * The available scopes for the OAuth2 security scheme. A map between the scope + * name and a short description for it. This field is required. + * + * @example { "read:pets": "read your pets", "write:pets": "modify pets in your account" } + */ + scopes: Record; } /** @@ -352,15 +352,15 @@ export interface OAuthFlow extends Extension { * ``` */ export interface SecurityRequirement { - /** - * Each name MUST correspond to a security scheme which is declared in the - * Security Schemes under the Components Object. The value is an array of - * scope names required for the execution. For OAuth2, the scopes are the - * scopes required for the execution. For other security schemes, the array - * MUST be empty. - * - * @example [] - * @example ["write:pets", "read:pets"] - */ - [name: string]: string[]; + /** + * Each name MUST correspond to a security scheme which is declared in the + * Security Schemes under the Components Object. The value is an array of + * scope names required for the execution. For OAuth2, the scopes are the + * scopes required for the execution. For other security schemes, the array + * MUST be empty. + * + * @example [] + * @example ["write:pets", "read:pets"] + */ + [name: string]: string[]; } diff --git a/3.1/servers.ts b/3.1/servers.ts index 2ccff94..2eae60e 100644 --- a/3.1/servers.ts +++ b/3.1/servers.ts @@ -57,34 +57,34 @@ import type { Extension } from "./extensions"; * ``` */ export interface Server extends Extension { - /** - * A URL to the target host. This URL supports Server Variables and MAY be relative, - * to indicate that the host location is relative to the location where the OpenAPI - * document is being served. Variable substitutions will be made when a variable - * is named in `{brackets}`. - * - * @example "https://api.example.com/v1" - * @example "https://{username}.gigantic-server.com:{port}/{basePath}" - * @example "/v1" - */ - url: string; + /** + * A URL to the target host. This URL supports Server Variables and MAY be relative, + * to indicate that the host location is relative to the location where the OpenAPI + * document is being served. Variable substitutions will be made when a variable + * is named in `{brackets}`. + * + * @example "https://api.example.com/v1" + * @example "https://{username}.gigantic-server.com:{port}/{basePath}" + * @example "/v1" + */ + url: string; - /** - * An optional string describing the host designated by the URL. CommonMark syntax - * MAY be used for rich text representation. - * - * @example "The production API server" - * @example "The staging API server" - */ - description?: string; + /** + * An optional string describing the host designated by the URL. CommonMark syntax + * MAY be used for rich text representation. + * + * @example "The production API server" + * @example "The staging API server" + */ + description?: string; - /** - * A map between a variable name and its value. The value is used for substitution - * in the server's URL template. - * - * @example { username: { default: "demo" }, port: { default: "8443" } } - */ - variables?: Record; + /** + * A map between a variable name and its value. The value is used for substitution + * in the server's URL template. + * + * @example { username: { default: "demo" }, port: { default: "8443" } } + */ + variables?: Record; } /** @@ -132,33 +132,33 @@ export interface Server extends Extension { * ``` */ export interface ServerVariable extends Extension { - /** - * An enumeration of string values to be used if the substitution options are - * from a limited set. The array SHOULD NOT be empty. - * - * @example ["8443", "443"] - * @example ["v1", "v2", "v3"] - */ - enum?: string[]; + /** + * An enumeration of string values to be used if the substitution options are + * from a limited set. The array SHOULD NOT be empty. + * + * @example ["8443", "443"] + * @example ["v1", "v2", "v3"] + */ + enum?: string[]; - /** - * The default value to use for substitution, which SHALL be sent if an alternate - * value is not supplied. Note this behavior is different than the Schema Object's - * treatment of default values, because in those cases parameter values are optional. - * If the enum is defined, the value SHOULD exist in the enum's values. - * - * @example "demo" - * @example "8443" - * @example "v1" - */ - default: string; + /** + * The default value to use for substitution, which SHALL be sent if an alternate + * value is not supplied. Note this behavior is different than the Schema Object's + * treatment of default values, because in those cases parameter values are optional. + * If the enum is defined, the value SHOULD exist in the enum's values. + * + * @example "demo" + * @example "8443" + * @example "v1" + */ + default: string; - /** - * An optional description for the server variable. CommonMark syntax MAY be used - * for rich text representation. - * - * @example "this value is assigned by the service provider" - * @example "The port number" - */ - description?: string; + /** + * An optional description for the server variable. CommonMark syntax MAY be used + * for rich text representation. + * + * @example "this value is assigned by the service provider" + * @example "The port number" + */ + description?: string; } diff --git a/3.1/spec.ts b/3.1/spec.ts index f9921eb..a2a3281 100644 --- a/3.1/spec.ts +++ b/3.1/spec.ts @@ -119,91 +119,91 @@ import type { Webhooks } from "./webhooks"; * ``` */ export interface Specification extends Extension { - /** - * This string MUST be the version number of the OpenAPI Specification that the - * OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret - * the OpenAPI document. This is not related to the API `info.version` string. - * This field is required. - * - * @example "3.1.0" - * @example "3.1.1" - */ - openapi: string; + /** + * This string MUST be the version number of the OpenAPI Specification that the + * OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret + * the OpenAPI document. This is not related to the API `info.version` string. + * This field is required. + * + * @example "3.1.0" + * @example "3.1.1" + */ + openapi: string; - /** - * Provides metadata about the API. The metadata MAY be used by tooling as required. - * This field is required. - * - * @example { title: "Pet Store API", version: "1.0.0" } - */ - info: Info; + /** + * Provides metadata about the API. The metadata MAY be used by tooling as required. + * This field is required. + * + * @example { title: "Pet Store API", version: "1.0.0" } + */ + info: Info; - /** - * The default value for the `$schema` keyword within Schema Objects contained - * within this OAS document. This MUST be in the form of a URI. - * - * @example "https://json-schema.org/draft/2020-12/schema" - */ - jsonSchemaDialect?: string; + /** + * The default value for the `$schema` keyword within Schema Objects contained + * within this OAS document. This MUST be in the form of a URI. + * + * @example "https://json-schema.org/draft/2020-12/schema" + */ + jsonSchemaDialect?: string; - /** - * An array of Server Objects, which provide connectivity information to a target - * server. If the `servers` property is not provided, or is an empty array, the - * default value would be a Server Object with a `url` value of `/`. - * - * @example [{ url: "https://api.example.com/v1", description: "The production API server" }] - */ - servers?: Server[]; + /** + * An array of Server Objects, which provide connectivity information to a target + * server. If the `servers` property is not provided, or is an empty array, the + * default value would be a Server Object with a `url` value of `/`. + * + * @example [{ url: "https://api.example.com/v1", description: "The production API server" }] + */ + servers?: Server[]; - /** - * The available paths and operations for the API. - * - * @example { "/pets": { "get": { "summary": "List all pets", "responses": { "200": { "description": "A list of pets" } } } } } - */ - paths?: Paths; + /** + * The available paths and operations for the API. + * + * @example { "/pets": { "get": { "summary": "List all pets", "responses": { "200": { "description": "A list of pets" } } } } } + */ + paths?: Paths; - /** - * The incoming webhooks that MAY be received as part of this API and that the - * API consumer MAY choose to implement. Closely related to the `callbacks` feature, - * this section describes requests initiated other than by an API call, for example - * by an out of band registration. - * - * @example { "newPet": { "post": { "requestBody": { "description": "Information about a new pet" } } } } - */ - webhooks?: Webhooks; + /** + * The incoming webhooks that MAY be received as part of this API and that the + * API consumer MAY choose to implement. Closely related to the `callbacks` feature, + * this section describes requests initiated other than by an API call, for example + * by an out of band registration. + * + * @example { "newPet": { "post": { "requestBody": { "description": "Information about a new pet" } } } } + */ + webhooks?: Webhooks; - /** - * An element to hold various schemas for the document. - * - * @example { schemas: { Pet: { type: "object", properties: { id: { type: "integer" } } } } } - */ - components?: Components; + /** + * An element to hold various schemas for the document. + * + * @example { schemas: { Pet: { type: "object", properties: { id: { type: "integer" } } } } } + */ + components?: Components; - /** - * 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. - * - * @example [{ "api_key": [] }] - */ - security?: SecurityRequirement[]; + /** + * 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. + * + * @example [{ "api_key": [] }] + */ + security?: SecurityRequirement[]; - /** - * A list of tags used by the document 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. - * - * @example [{ name: "pets", description: "Pet store operations" }] - */ - tags?: Tag[]; + /** + * A list of tags used by the document 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. + * + * @example [{ name: "pets", description: "Pet store operations" }] + */ + tags?: Tag[]; - /** - * Additional external documentation. - * - * @example { description: "Find out more about our API", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation. + * + * @example { description: "Find out more about our API", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; } diff --git a/3.1/status.ts b/3.1/status.ts index dd1f491..c617eab 100644 --- a/3.1/status.ts +++ b/3.1/status.ts @@ -11,989 +11,989 @@ import type { Response } from "./paths"; * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html | RFC 9110: HTTP Semantics} */ export interface ResponsesMap { - //#region Family Codes - - /** 1xx — Informational - * - * Indicates that the request was received and the server is continuing to process it. - * - * Used for provisional responses that indicate the server has received the request and is continuing to process it. These responses are typically used for status updates during long-running operations or to indicate that the server is ready to receive additional data. - * - * The client should continue waiting for the final response. These are provisional responses and the client should not consider the request complete until receiving a final status code. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "1xx"?: Response; - - /** 2xx — Success - * - * Indicates that the request was successfully received, understood, and accepted. - * - * Used for successful operations where the request was processed successfully and the response contains the requested data or indicates successful completion of the operation. - * - * The operation completed successfully. The response body typically contains the requested data or confirmation of the successful operation. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "2xx"?: Response; - - /** 3xx — Redirection - * - * Indicates that further action needs to be taken by the client to complete the request. - * - * Used when the client needs to take additional action to complete the request, such as following a redirect, providing authentication, or accessing the resource at a different location. - * - * The client needs to take additional action to complete the request. This may involve following a redirect, providing authentication, or accessing the resource at a different location. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "3xx"?: Response; - - /** 4xx — Client Error - * - * Indicates that the request contains bad syntax or cannot be fulfilled by the server. - * - * Used when the client has sent an invalid request, such as malformed syntax, invalid parameters, authentication failures, or requests for non-existent resources. - * - * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "4xx"?: Response; - - /** 5xx — Server Error - * - * Indicates that the server failed to fulfill a valid request. - * - * Used when the server encounters an error while processing a valid request, such as internal server errors, service unavailability, or gateway timeouts. - * - * The server encountered an error while processing the request. The client should retry the request later, as this is typically a temporary issue. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "5xx"?: Response; - - //#endregion - - //#region 1xx — Informational - - /** 100 Continue - * - * Indicates that the initial part of the request has been received and the client should continue with the request. - * - * The server has received the request headers and the client should proceed to send the request body. - * - * Used in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns. - * - * The server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue | RFC 9110 §15.2.1} - */ - "100"?: Response; - - /** 101 Switching Protocols - * - * Indicates that the server is switching protocols as requested by the client. - * - * The server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols. - * - * Primarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios. - * - * The connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols | RFC 9110 §15.2.2} - */ - "101"?: Response; - - /** 102 Processing - * - * Indicates that the server has received and is processing the request, but no response is available yet. - * - * The server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting. - * - * Primarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods. - * - * The request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2518 | RFC 2518 (WebDAV)} - */ - "102"?: Response; - - /** 103 Early Hints - * - * Provides early hints about the response that will be sent, allowing the client to start processing before the full response is ready. - * - * The server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early. - * - * Used for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance. - * - * The client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc8297 | RFC 8297} - */ - "103"?: Response; - - /** 104 Upload Resumption Supported — TEMPORARY - * - * Indicates that the server supports resumable uploads for the requested resource. - * - * The server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off. - * - * Used in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste. - * - * The client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions. - * - * @note Temporary registration; see IANA entry for current status/expiry. - * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05 | draft-ietf-httpbis-resumable-upload-05} - * @see {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | IANA registry} - */ - "104"?: Response; - - //#endregion - - //#region 2xx — Success - - /** 200 OK - * - * Indicates that the request has succeeded and the response contains the requested data. - * - * The request was processed successfully and the response body contains the requested resource or data. - * - * The most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return. - * - * The operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok | RFC 9110 §15.3.1} - */ - "200"?: Response; - - /** 201 Created - * - * Indicates that the request has succeeded and a new resource has been created as a result. - * - * The request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource. - * - * Used for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations. - * - * A new resource was successfully created and the response contains information about the created resource, typically including its ID and location. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created | RFC 9110 §15.3.2} - */ - "201"?: Response; - - /** 202 Accepted - * - * Indicates that the request has been accepted for processing, but the processing has not been completed. - * - * The request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed. - * - * Used for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone. - * - * The request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted | RFC 9110 §15.3.3} - */ - "202"?: Response; - - /** 203 Non-Authoritative Information - * - * Indicates that the request was successful, but the information returned is from a transformed or cached version of the original resource. - * - * The response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version. - * - * Used when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware. - * - * The request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-informat | RFC 9110 §15.3.4} - */ - "203"?: Response; - - /** 204 No Content - * - * Indicates that the request has succeeded but there is no content to return in the response body. - * - * The request was processed successfully but the response body is intentionally empty. The client should not expect any content. - * - * Used for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data. - * - * The operation completed successfully but no data is returned. The client should not attempt to parse a response body. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content | RFC 9110 §15.3.5} - */ - "204"?: Response; - - /** 205 Reset Content - * - * Indicates that the request has succeeded and the client should reset the document view that caused the request to be sent. - * - * The request was processed successfully and the client should clear any form data or reset the user interface state. - * - * Used in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations. - * - * The operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content | RFC 9110 §15.3.6} - */ - "205"?: Response; - - /** 206 Partial Content - * - * Indicates that the server is delivering only part of the resource due to a range request. - * - * The request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered. - * - * Used for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads. - * - * The response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content | RFC 9110 §15.3.7} - */ - "206"?: Response; - - /** 207 Multi-Status - * - * Indicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body. - * - * The response contains multiple status codes for different operations, typically in XML format with individual operation results. - * - * Used in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms. - * - * Multiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "207"?: Response; - - /** 208 Already Reported - * - * Indicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again. - * - * Used in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported. - * - * Used in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations. - * - * The information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} - */ - "208"?: Response; - - /** 226 IM Used - * - * Indicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. - * - * The response represents the result of applying instance manipulations (like delta encoding) to the current resource instance. - * - * Used in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission. - * - * The response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc3229 | RFC 3229} - */ - "226"?: Response; - - //#endregion - - //#region 3xx — Redirection - - /** 300 Multiple Choices - * - * Indicates that the request has multiple possible responses and the client should choose one. - * - * The server has multiple representations of the requested resource and the client must choose which one to use. - * - * Used when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics. - * - * The client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices | RFC 9110 §15.4.1} - */ - "300"?: Response; - - /** 301 Moved Permanently - * - * Indicates that the requested resource has been permanently moved to a new location. - * - * The resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header. - * - * Used when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches. - * - * The resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently | RFC 9110 §15.4.2} - */ - "301"?: Response; - - /** 302 Found - * - * Indicates that the requested resource has been temporarily moved to a different location. - * - * The resource is temporarily available at a different URL, but the original URL should continue to be used for future requests. - * - * Used for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid. - * - * The resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found | RFC 9110 §15.4.3} - */ - "302"?: Response; - - /** 303 See Other - * - * Indicates that the response to the request can be found at a different URL and should be retrieved using a GET request. - * - * The request was processed but the response is available at a different location, and the client should use GET to retrieve it. - * - * Used in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions. - * - * The client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other | RFC 9110 §15.4.4} - */ - "303"?: Response; - - /** 304 Not Modified - * - * Indicates that the resource has not been modified since the last request, so the cached version can be used. - * - * The resource has not changed since the last request, and the client can use its cached version. No response body is included. - * - * Used for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer. - * - * The resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified | RFC 9110 §15.4.5} - */ - "304"?: Response; - - /** 305 Use Proxy - * - * Indicates that the requested resource must be accessed through the proxy specified in the Location header. - * - * The client must use the specified proxy to access the resource. This response is rarely used in modern web applications. - * - * Used in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development. - * - * The client should use the specified proxy to access the resource. This is rarely encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy | RFC 9110 §15.4.6} - */ - "305"?: Response; - - /** 306 (Unused) - * - * This status code is reserved and not used in current HTTP specifications. - * - * This status code was previously used but is now reserved and should not be used in new implementations. - * - * Not used in modern web applications. This code is reserved and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-306-unused | RFC 9110 §15.4.7} - */ - "306"?: Response; - - /** 307 Temporary Redirect - * - * Indicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved. - * - * The resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location. - * - * Used for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated. - * - * The resource is temporarily at a different location and the client should repeat the same request method to the new URL. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect | RFC 9110 §15.4.8} - */ - "307"?: Response; - - /** 308 Permanent Redirect - * - * Indicates that the requested resource has been permanently moved to a different location, and the request method should be preserved. - * - * The resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method. - * - * Used for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations. - * - * The resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect | RFC 9110 §15.4.9} - */ - "308"?: Response; - - //#endregion - - //#region 4xx — Client Error - - /** 400 Bad Request - * - * Indicates that the server cannot process the request due to a client error. - * - * The request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process. - * - * Used for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios. - * - * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request | RFC 9110 §15.5.1} - */ - "400"?: Response; - - /** 401 Unauthorized - * - * Indicates that the request requires authentication and the client has not provided valid credentials. - * - * The request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient. - * - * Used when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows. - * - * The client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized | RFC 9110 §15.5.2} - */ - "401"?: Response; - - /** 402 Payment Required - * - * Indicates that the request requires payment before it can be processed. - * - * The request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems. - * - * Used in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services. - * - * The client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required | RFC 9110 §15.5.3} - */ - "402"?: Response; - - /** 403 Forbidden - * - * Indicates that the server understood the request but refuses to authorize it. - * - * The client is authenticated but does not have permission to access the requested resource or perform the requested action. - * - * Used when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios. - * - * The client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden | RFC 9110 §15.5.4} - */ - "403"?: Response; - - /** 404 Not Found - * - * Indicates that the requested resource could not be found on the server. - * - * The server cannot find the requested resource at the specified URL, or the resource does not exist. - * - * Used when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints. - * - * The requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found | RFC 9110 §15.5.5} - */ - "404"?: Response; - - /** 405 Method Not Allowed - * - * Indicates that the HTTP method used in the request is not allowed for the requested resource. - * - * The resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource. - * - * Used when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design. - * - * The HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed | RFC 9110 §15.5.6} - */ - "405"?: Response; - - /** 406 Not Acceptable - * - * Indicates that the server cannot produce a response matching the client's Accept headers. - * - * The server cannot generate a response in any of the formats requested by the client's Accept headers. - * - * Used when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches. - * - * The server cannot provide the requested content type. The client should check the Accept headers or request a different format. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable | RFC 9110 §15.5.7} - */ - "406"?: Response; - - /** 407 Proxy Authentication Required - * - * Indicates that the client must authenticate with the proxy server before the request can be processed. - * - * The proxy server requires authentication before it will forward the request to the destination server. - * - * Used in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies. - * - * The client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-req | RFC 9110 §15.5.8} - */ - "407"?: Response; - - /** 408 Request Timeout - * - * Indicates that the server timed out while waiting for the request from the client. - * - * The server did not receive a complete request within the time it was prepared to wait. - * - * Used when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests. - * - * The request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout | RFC 9110 §15.5.9} - */ - "408"?: Response; - - /** 409 Conflict - * - * Indicates that the request conflicts with the current state of the resource. - * - * The request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification. - * - * Used when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios. - * - * The request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | RFC 9110 §15.5.10} - */ - "409"?: Response; - - /** 410 Gone - * - * Indicates that the requested resource is no longer available and will not be available again. - * - * The resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found. - * - * Used when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios. - * - * The resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone | RFC 9110 §15.5.11} - */ - "410"?: Response; - - /** 411 Length Required - * - * Indicates that the server requires a Content-Length header in the request. - * - * The server cannot process the request without knowing the exact length of the request body. - * - * Used when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints. - * - * The client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required | RFC 9110 §15.5.12} - */ - "411"?: Response; - - /** 412 Precondition Failed - * - * Indicates that one or more preconditions in the request headers were not met. - * - * The server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since. - * - * Used in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios. - * - * The preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed | RFC 9110 §15.5.13} - */ - "412"?: Response; - - /** 413 Content Too Large - * - * Indicates that the request payload is too large for the server to process. - * - * The request body exceeds the server's maximum allowed size limit. - * - * Used when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting. - * - * The request payload is too large. The client should reduce the size of the request body or split it into smaller chunks. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large | RFC 9110 §15.5.14} - */ - "413"?: Response; - - /** 414 URI Too Long - * - * Indicates that the URI provided in the request is too long for the server to process. - * - * The URL exceeds the server's maximum allowed length limit. - * - * Used when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests. - * - * The URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long | RFC 9110 §15.5.15} - */ - "414"?: Response; - - /** 415 Unsupported Media Type - * - * Indicates that the server cannot process the request because the media type is not supported. - * - * The server cannot process the request body because the Content-Type is not supported or recognized. - * - * Used when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements. - * - * The content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type | RFC 9110 §15.5.16} - */ - "415"?: Response; - - /** 416 Range Not Satisfiable - * - * Indicates that the server cannot satisfy the range request specified in the Range header. - * - * The requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests. - * - * Used when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming. - * - * The range request is not satisfiable. The client should check the range specification or request the full resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable | RFC 9110 §15.5.17} - */ - "416"?: Response; - - /** 417 Expectation Failed - * - * Indicates that the server cannot meet the requirements of the Expect header. - * - * The server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation. - * - * Used when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations. - * - * The server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed | RFC 9110 §15.5.18} - */ - "417"?: Response; - - /** 418 (Unused) - * - * This status code is reserved and not used in current HTTP specifications. - * - * This status code is reserved and should not be used in new implementations. - * - * Not used in modern web applications. This code is reserved and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-418-unused | RFC 9110 §15.5.19} - */ - "418"?: Response; - - /** 421 Misdirected Request - * - * Indicates that the request was directed to a server that is not able to produce a response. - * - * The request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems. - * - * Used in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios. - * - * The request was sent to the wrong server. The client should retry the request, which may be routed to a different server. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request | RFC 9110 §15.5.20} - */ - "421"?: Response; - - /** 422 Unprocessable Content - * - * Indicates that the request is well-formed but contains semantic errors that prevent processing. - * - * The request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations. - * - * Used for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid. - * - * The request is well-formed but contains semantic errors. The client should fix the data and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content | RFC 9110 §15.5.21} - */ - "422"?: Response; - - /** 423 Locked - * - * Indicates that the requested resource is locked and cannot be modified. - * - * The resource is locked by another process or user and cannot be accessed or modified at this time. - * - * Used in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms. - * - * The resource is locked and cannot be accessed. The client should wait and retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "423"?: Response; - - /** 424 Failed Dependency - * - * Indicates that the request failed because it depended on another request that also failed. - * - * The request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations. - * - * Used in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios. - * - * The request failed due to a dependency failure. The client should check the dependencies and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "424"?: Response; - - /** 425 Too Early - * - * Indicates that the server is unwilling to process the request because it might be replayed. - * - * The server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns. - * - * Used in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols. - * - * The server is unwilling to process the request due to replay concerns. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc8470 | RFC 8470} - */ - "425"?: Response; - - /** 426 Upgrade Required - * - * Indicates that the server requires the client to upgrade to a different protocol. - * - * The server requires the client to use a different protocol version or upgrade to a newer version to access the resource. - * - * Used when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios. - * - * The client must upgrade to a different protocol version. The response should include upgrade information. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required | RFC 9110 §15.5.22} - */ - "426"?: Response; - - /** 428 Precondition Required - * - * Indicates that the server requires the request to include certain preconditions. - * - * The server requires the client to include specific preconditions in the request headers before it will process the request. - * - * Used when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios. - * - * The server requires specific preconditions. The client should include the required preconditions and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "428"?: Response; - - /** 429 Too Many Requests - * - * Indicates that the client has sent too many requests in a given time period and should slow down. - * - * The client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets. - * - * Used for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers. - * - * The client has exceeded the rate limit and should slow down. The client should wait before retrying the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "429"?: Response; - - /** 431 Request Header Fields Too Large - * - * Indicates that the server is unwilling to process the request because the header fields are too large. - * - * The request headers exceed the server's maximum allowed size limit. - * - * Used when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data. - * - * The request headers are too large. The client should reduce the size of the headers and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "431"?: Response; - - /** 451 Unavailable For Legal Reasons - * - * Indicates that the requested resource is unavailable due to legal reasons. - * - * The resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements. - * - * Used when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services. - * - * The resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc7725 | RFC 7725} - */ - "451"?: Response; - - //#endregion - - //#region 5xx — Server Error - - /** 500 Internal Server Error - * - * Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. - * - * The server encountered an internal error or exception that prevented it from processing the request successfully. - * - * Used for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems. - * - * The server encountered an internal error. The client should retry the request later, as this is typically a temporary issue. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error | RFC 9110 §15.6.1} - */ - "500"?: Response; - - /** 501 Not Implemented - * - * Indicates that the server does not support the functionality required to fulfill the request. - * - * The server does not recognize the request method or lacks the ability to fulfill the request. - * - * Used when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented. - * - * The server does not support the requested functionality. The client should check the API documentation for supported methods and features. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented | RFC 9110 §15.6.2} - */ - "501"?: Response; - - /** 502 Bad Gateway - * - * Indicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server. - * - * The server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access. - * - * Used in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems. - * - * The gateway received an invalid response from the upstream server. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway | RFC 9110 §15.6.3} - */ - "502"?: Response; - - /** 503 Service Unavailable - * - * Indicates that the server is temporarily unable to handle the request due to maintenance or overload. - * - * The server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints. - * - * Used during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows. - * - * The server is temporarily unavailable. The client should retry the request later, often with exponential backoff. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable | RFC 9110 §15.6.4} - */ - "503"?: Response; - - /** 504 Gateway Timeout - * - * Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server. - * - * The gateway or proxy server timed out while waiting for a response from the upstream server. - * - * Used in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times. - * - * The gateway timed out waiting for the upstream server. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout | RFC 9110 §15.6.5} - */ - "504"?: Response; - - /** 505 HTTP Version Not Supported - * - * Indicates that the server does not support the HTTP protocol version used in the request. - * - * The server does not support the HTTP protocol version specified in the request. - * - * Used when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios. - * - * The server does not support the HTTP version used in the request. The client should use a supported HTTP version. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-supporte | RFC 9110 §15.6.6} - */ - "505"?: Response; - - /** 506 Variant Also Negotiates - * - * Indicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation. - * - * The server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop. - * - * Used in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations. - * - * The server has a configuration error in content negotiation. The client should contact the server administrator. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2295 | RFC 2295} - */ - "506"?: Response; - - /** 507 Insufficient Storage - * - * Indicates that the server is unable to store the representation needed to complete the request. - * - * The server cannot store the representation required to complete the request, typically due to storage space limitations. - * - * Used in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms. - * - * The server cannot store the required representation. The client should check storage availability and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "507"?: Response; - - /** 508 Loop Detected - * - * Indicates that the server detected an infinite loop while processing the request. - * - * The server detected an infinite loop in the request processing, typically in WebDAV operations. - * - * Used in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios. - * - * The server detected an infinite loop. The client should check the request for circular references and retry. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} - */ - "508"?: Response; - - /** 510 Not Extended — OBSOLETED - * - * This status code is obsolete and should not be used in modern implementations. - * - * This status code was used for HTTP extensions but is now obsolete and should not be used. - * - * Not used in modern web applications. This code is obsolete and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2774 | RFC 2774 (Historic)} - * @see {@link https://datatracker.ietf.org/doc/status-change-http-experiments-to-historic/ | IETF: Status change of HTTP experiments to Historic} - */ - "510"?: Response; - - /** 511 Network Authentication Required - * - * Indicates that the client needs to authenticate to gain network access. - * - * The client must authenticate with the network before it can access the requested resource. - * - * Used in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication. - * - * The client needs to authenticate with the network. The client should follow the authentication process provided by the network. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "511"?: Response; - - //#endregion - - /** default — The default response for all codes not covered individually. */ - default?: Response; + //#region Family Codes + + /** 1xx — Informational + * + * Indicates that the request was received and the server is continuing to process it. + * + * Used for provisional responses that indicate the server has received the request and is continuing to process it. These responses are typically used for status updates during long-running operations or to indicate that the server is ready to receive additional data. + * + * The client should continue waiting for the final response. These are provisional responses and the client should not consider the request complete until receiving a final status code. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "1xx"?: Response; + + /** 2xx — Success + * + * Indicates that the request was successfully received, understood, and accepted. + * + * Used for successful operations where the request was processed successfully and the response contains the requested data or indicates successful completion of the operation. + * + * The operation completed successfully. The response body typically contains the requested data or confirmation of the successful operation. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "2xx"?: Response; + + /** 3xx — Redirection + * + * Indicates that further action needs to be taken by the client to complete the request. + * + * Used when the client needs to take additional action to complete the request, such as following a redirect, providing authentication, or accessing the resource at a different location. + * + * The client needs to take additional action to complete the request. This may involve following a redirect, providing authentication, or accessing the resource at a different location. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "3xx"?: Response; + + /** 4xx — Client Error + * + * Indicates that the request contains bad syntax or cannot be fulfilled by the server. + * + * Used when the client has sent an invalid request, such as malformed syntax, invalid parameters, authentication failures, or requests for non-existent resources. + * + * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "4xx"?: Response; + + /** 5xx — Server Error + * + * Indicates that the server failed to fulfill a valid request. + * + * Used when the server encounters an error while processing a valid request, such as internal server errors, service unavailability, or gateway timeouts. + * + * The server encountered an error while processing the request. The client should retry the request later, as this is typically a temporary issue. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "5xx"?: Response; + + //#endregion + + //#region 1xx — Informational + + /** 100 Continue + * + * Indicates that the initial part of the request has been received and the client should continue with the request. + * + * The server has received the request headers and the client should proceed to send the request body. + * + * Used in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns. + * + * The server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue | RFC 9110 §15.2.1} + */ + "100"?: Response; + + /** 101 Switching Protocols + * + * Indicates that the server is switching protocols as requested by the client. + * + * The server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols. + * + * Primarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios. + * + * The connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols | RFC 9110 §15.2.2} + */ + "101"?: Response; + + /** 102 Processing + * + * Indicates that the server has received and is processing the request, but no response is available yet. + * + * The server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting. + * + * Primarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods. + * + * The request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2518 | RFC 2518 (WebDAV)} + */ + "102"?: Response; + + /** 103 Early Hints + * + * Provides early hints about the response that will be sent, allowing the client to start processing before the full response is ready. + * + * The server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early. + * + * Used for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance. + * + * The client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc8297 | RFC 8297} + */ + "103"?: Response; + + /** 104 Upload Resumption Supported — TEMPORARY + * + * Indicates that the server supports resumable uploads for the requested resource. + * + * The server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off. + * + * Used in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste. + * + * The client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions. + * + * @note Temporary registration; see IANA entry for current status/expiry. + * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05 | draft-ietf-httpbis-resumable-upload-05} + * @see {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | IANA registry} + */ + "104"?: Response; + + //#endregion + + //#region 2xx — Success + + /** 200 OK + * + * Indicates that the request has succeeded and the response contains the requested data. + * + * The request was processed successfully and the response body contains the requested resource or data. + * + * The most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return. + * + * The operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok | RFC 9110 §15.3.1} + */ + "200"?: Response; + + /** 201 Created + * + * Indicates that the request has succeeded and a new resource has been created as a result. + * + * The request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource. + * + * Used for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations. + * + * A new resource was successfully created and the response contains information about the created resource, typically including its ID and location. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created | RFC 9110 §15.3.2} + */ + "201"?: Response; + + /** 202 Accepted + * + * Indicates that the request has been accepted for processing, but the processing has not been completed. + * + * The request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed. + * + * Used for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone. + * + * The request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted | RFC 9110 §15.3.3} + */ + "202"?: Response; + + /** 203 Non-Authoritative Information + * + * Indicates that the request was successful, but the information returned is from a transformed or cached version of the original resource. + * + * The response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version. + * + * Used when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware. + * + * The request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-informat | RFC 9110 §15.3.4} + */ + "203"?: Response; + + /** 204 No Content + * + * Indicates that the request has succeeded but there is no content to return in the response body. + * + * The request was processed successfully but the response body is intentionally empty. The client should not expect any content. + * + * Used for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data. + * + * The operation completed successfully but no data is returned. The client should not attempt to parse a response body. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content | RFC 9110 §15.3.5} + */ + "204"?: Response; + + /** 205 Reset Content + * + * Indicates that the request has succeeded and the client should reset the document view that caused the request to be sent. + * + * The request was processed successfully and the client should clear any form data or reset the user interface state. + * + * Used in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations. + * + * The operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content | RFC 9110 §15.3.6} + */ + "205"?: Response; + + /** 206 Partial Content + * + * Indicates that the server is delivering only part of the resource due to a range request. + * + * The request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered. + * + * Used for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads. + * + * The response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content | RFC 9110 §15.3.7} + */ + "206"?: Response; + + /** 207 Multi-Status + * + * Indicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body. + * + * The response contains multiple status codes for different operations, typically in XML format with individual operation results. + * + * Used in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms. + * + * Multiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "207"?: Response; + + /** 208 Already Reported + * + * Indicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again. + * + * Used in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported. + * + * Used in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations. + * + * The information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} + */ + "208"?: Response; + + /** 226 IM Used + * + * Indicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. + * + * The response represents the result of applying instance manipulations (like delta encoding) to the current resource instance. + * + * Used in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission. + * + * The response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc3229 | RFC 3229} + */ + "226"?: Response; + + //#endregion + + //#region 3xx — Redirection + + /** 300 Multiple Choices + * + * Indicates that the request has multiple possible responses and the client should choose one. + * + * The server has multiple representations of the requested resource and the client must choose which one to use. + * + * Used when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics. + * + * The client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices | RFC 9110 §15.4.1} + */ + "300"?: Response; + + /** 301 Moved Permanently + * + * Indicates that the requested resource has been permanently moved to a new location. + * + * The resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header. + * + * Used when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches. + * + * The resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently | RFC 9110 §15.4.2} + */ + "301"?: Response; + + /** 302 Found + * + * Indicates that the requested resource has been temporarily moved to a different location. + * + * The resource is temporarily available at a different URL, but the original URL should continue to be used for future requests. + * + * Used for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid. + * + * The resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found | RFC 9110 §15.4.3} + */ + "302"?: Response; + + /** 303 See Other + * + * Indicates that the response to the request can be found at a different URL and should be retrieved using a GET request. + * + * The request was processed but the response is available at a different location, and the client should use GET to retrieve it. + * + * Used in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions. + * + * The client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other | RFC 9110 §15.4.4} + */ + "303"?: Response; + + /** 304 Not Modified + * + * Indicates that the resource has not been modified since the last request, so the cached version can be used. + * + * The resource has not changed since the last request, and the client can use its cached version. No response body is included. + * + * Used for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer. + * + * The resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified | RFC 9110 §15.4.5} + */ + "304"?: Response; + + /** 305 Use Proxy + * + * Indicates that the requested resource must be accessed through the proxy specified in the Location header. + * + * The client must use the specified proxy to access the resource. This response is rarely used in modern web applications. + * + * Used in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development. + * + * The client should use the specified proxy to access the resource. This is rarely encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy | RFC 9110 §15.4.6} + */ + "305"?: Response; + + /** 306 (Unused) + * + * This status code is reserved and not used in current HTTP specifications. + * + * This status code was previously used but is now reserved and should not be used in new implementations. + * + * Not used in modern web applications. This code is reserved and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-306-unused | RFC 9110 §15.4.7} + */ + "306"?: Response; + + /** 307 Temporary Redirect + * + * Indicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved. + * + * The resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location. + * + * Used for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated. + * + * The resource is temporarily at a different location and the client should repeat the same request method to the new URL. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect | RFC 9110 §15.4.8} + */ + "307"?: Response; + + /** 308 Permanent Redirect + * + * Indicates that the requested resource has been permanently moved to a different location, and the request method should be preserved. + * + * The resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method. + * + * Used for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations. + * + * The resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect | RFC 9110 §15.4.9} + */ + "308"?: Response; + + //#endregion + + //#region 4xx — Client Error + + /** 400 Bad Request + * + * Indicates that the server cannot process the request due to a client error. + * + * The request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process. + * + * Used for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios. + * + * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request | RFC 9110 §15.5.1} + */ + "400"?: Response; + + /** 401 Unauthorized + * + * Indicates that the request requires authentication and the client has not provided valid credentials. + * + * The request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient. + * + * Used when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows. + * + * The client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized | RFC 9110 §15.5.2} + */ + "401"?: Response; + + /** 402 Payment Required + * + * Indicates that the request requires payment before it can be processed. + * + * The request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems. + * + * Used in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services. + * + * The client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required | RFC 9110 §15.5.3} + */ + "402"?: Response; + + /** 403 Forbidden + * + * Indicates that the server understood the request but refuses to authorize it. + * + * The client is authenticated but does not have permission to access the requested resource or perform the requested action. + * + * Used when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios. + * + * The client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden | RFC 9110 §15.5.4} + */ + "403"?: Response; + + /** 404 Not Found + * + * Indicates that the requested resource could not be found on the server. + * + * The server cannot find the requested resource at the specified URL, or the resource does not exist. + * + * Used when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints. + * + * The requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found | RFC 9110 §15.5.5} + */ + "404"?: Response; + + /** 405 Method Not Allowed + * + * Indicates that the HTTP method used in the request is not allowed for the requested resource. + * + * The resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource. + * + * Used when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design. + * + * The HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed | RFC 9110 §15.5.6} + */ + "405"?: Response; + + /** 406 Not Acceptable + * + * Indicates that the server cannot produce a response matching the client's Accept headers. + * + * The server cannot generate a response in any of the formats requested by the client's Accept headers. + * + * Used when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches. + * + * The server cannot provide the requested content type. The client should check the Accept headers or request a different format. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable | RFC 9110 §15.5.7} + */ + "406"?: Response; + + /** 407 Proxy Authentication Required + * + * Indicates that the client must authenticate with the proxy server before the request can be processed. + * + * The proxy server requires authentication before it will forward the request to the destination server. + * + * Used in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies. + * + * The client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-req | RFC 9110 §15.5.8} + */ + "407"?: Response; + + /** 408 Request Timeout + * + * Indicates that the server timed out while waiting for the request from the client. + * + * The server did not receive a complete request within the time it was prepared to wait. + * + * Used when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests. + * + * The request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout | RFC 9110 §15.5.9} + */ + "408"?: Response; + + /** 409 Conflict + * + * Indicates that the request conflicts with the current state of the resource. + * + * The request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification. + * + * Used when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios. + * + * The request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | RFC 9110 §15.5.10} + */ + "409"?: Response; + + /** 410 Gone + * + * Indicates that the requested resource is no longer available and will not be available again. + * + * The resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found. + * + * Used when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios. + * + * The resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone | RFC 9110 §15.5.11} + */ + "410"?: Response; + + /** 411 Length Required + * + * Indicates that the server requires a Content-Length header in the request. + * + * The server cannot process the request without knowing the exact length of the request body. + * + * Used when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints. + * + * The client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required | RFC 9110 §15.5.12} + */ + "411"?: Response; + + /** 412 Precondition Failed + * + * Indicates that one or more preconditions in the request headers were not met. + * + * The server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since. + * + * Used in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios. + * + * The preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed | RFC 9110 §15.5.13} + */ + "412"?: Response; + + /** 413 Content Too Large + * + * Indicates that the request payload is too large for the server to process. + * + * The request body exceeds the server's maximum allowed size limit. + * + * Used when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting. + * + * The request payload is too large. The client should reduce the size of the request body or split it into smaller chunks. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large | RFC 9110 §15.5.14} + */ + "413"?: Response; + + /** 414 URI Too Long + * + * Indicates that the URI provided in the request is too long for the server to process. + * + * The URL exceeds the server's maximum allowed length limit. + * + * Used when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests. + * + * The URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long | RFC 9110 §15.5.15} + */ + "414"?: Response; + + /** 415 Unsupported Media Type + * + * Indicates that the server cannot process the request because the media type is not supported. + * + * The server cannot process the request body because the Content-Type is not supported or recognized. + * + * Used when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements. + * + * The content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type | RFC 9110 §15.5.16} + */ + "415"?: Response; + + /** 416 Range Not Satisfiable + * + * Indicates that the server cannot satisfy the range request specified in the Range header. + * + * The requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests. + * + * Used when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming. + * + * The range request is not satisfiable. The client should check the range specification or request the full resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable | RFC 9110 §15.5.17} + */ + "416"?: Response; + + /** 417 Expectation Failed + * + * Indicates that the server cannot meet the requirements of the Expect header. + * + * The server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation. + * + * Used when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations. + * + * The server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed | RFC 9110 §15.5.18} + */ + "417"?: Response; + + /** 418 (Unused) + * + * This status code is reserved and not used in current HTTP specifications. + * + * This status code is reserved and should not be used in new implementations. + * + * Not used in modern web applications. This code is reserved and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-418-unused | RFC 9110 §15.5.19} + */ + "418"?: Response; + + /** 421 Misdirected Request + * + * Indicates that the request was directed to a server that is not able to produce a response. + * + * The request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems. + * + * Used in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios. + * + * The request was sent to the wrong server. The client should retry the request, which may be routed to a different server. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request | RFC 9110 §15.5.20} + */ + "421"?: Response; + + /** 422 Unprocessable Content + * + * Indicates that the request is well-formed but contains semantic errors that prevent processing. + * + * The request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations. + * + * Used for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid. + * + * The request is well-formed but contains semantic errors. The client should fix the data and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content | RFC 9110 §15.5.21} + */ + "422"?: Response; + + /** 423 Locked + * + * Indicates that the requested resource is locked and cannot be modified. + * + * The resource is locked by another process or user and cannot be accessed or modified at this time. + * + * Used in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms. + * + * The resource is locked and cannot be accessed. The client should wait and retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "423"?: Response; + + /** 424 Failed Dependency + * + * Indicates that the request failed because it depended on another request that also failed. + * + * The request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations. + * + * Used in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios. + * + * The request failed due to a dependency failure. The client should check the dependencies and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "424"?: Response; + + /** 425 Too Early + * + * Indicates that the server is unwilling to process the request because it might be replayed. + * + * The server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns. + * + * Used in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols. + * + * The server is unwilling to process the request due to replay concerns. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc8470 | RFC 8470} + */ + "425"?: Response; + + /** 426 Upgrade Required + * + * Indicates that the server requires the client to upgrade to a different protocol. + * + * The server requires the client to use a different protocol version or upgrade to a newer version to access the resource. + * + * Used when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios. + * + * The client must upgrade to a different protocol version. The response should include upgrade information. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required | RFC 9110 §15.5.22} + */ + "426"?: Response; + + /** 428 Precondition Required + * + * Indicates that the server requires the request to include certain preconditions. + * + * The server requires the client to include specific preconditions in the request headers before it will process the request. + * + * Used when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios. + * + * The server requires specific preconditions. The client should include the required preconditions and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "428"?: Response; + + /** 429 Too Many Requests + * + * Indicates that the client has sent too many requests in a given time period and should slow down. + * + * The client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets. + * + * Used for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers. + * + * The client has exceeded the rate limit and should slow down. The client should wait before retrying the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "429"?: Response; + + /** 431 Request Header Fields Too Large + * + * Indicates that the server is unwilling to process the request because the header fields are too large. + * + * The request headers exceed the server's maximum allowed size limit. + * + * Used when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data. + * + * The request headers are too large. The client should reduce the size of the headers and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "431"?: Response; + + /** 451 Unavailable For Legal Reasons + * + * Indicates that the requested resource is unavailable due to legal reasons. + * + * The resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements. + * + * Used when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services. + * + * The resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc7725 | RFC 7725} + */ + "451"?: Response; + + //#endregion + + //#region 5xx — Server Error + + /** 500 Internal Server Error + * + * Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. + * + * The server encountered an internal error or exception that prevented it from processing the request successfully. + * + * Used for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems. + * + * The server encountered an internal error. The client should retry the request later, as this is typically a temporary issue. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error | RFC 9110 §15.6.1} + */ + "500"?: Response; + + /** 501 Not Implemented + * + * Indicates that the server does not support the functionality required to fulfill the request. + * + * The server does not recognize the request method or lacks the ability to fulfill the request. + * + * Used when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented. + * + * The server does not support the requested functionality. The client should check the API documentation for supported methods and features. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented | RFC 9110 §15.6.2} + */ + "501"?: Response; + + /** 502 Bad Gateway + * + * Indicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server. + * + * The server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access. + * + * Used in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems. + * + * The gateway received an invalid response from the upstream server. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway | RFC 9110 §15.6.3} + */ + "502"?: Response; + + /** 503 Service Unavailable + * + * Indicates that the server is temporarily unable to handle the request due to maintenance or overload. + * + * The server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints. + * + * Used during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows. + * + * The server is temporarily unavailable. The client should retry the request later, often with exponential backoff. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable | RFC 9110 §15.6.4} + */ + "503"?: Response; + + /** 504 Gateway Timeout + * + * Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server. + * + * The gateway or proxy server timed out while waiting for a response from the upstream server. + * + * Used in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times. + * + * The gateway timed out waiting for the upstream server. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout | RFC 9110 §15.6.5} + */ + "504"?: Response; + + /** 505 HTTP Version Not Supported + * + * Indicates that the server does not support the HTTP protocol version used in the request. + * + * The server does not support the HTTP protocol version specified in the request. + * + * Used when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios. + * + * The server does not support the HTTP version used in the request. The client should use a supported HTTP version. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-supporte | RFC 9110 §15.6.6} + */ + "505"?: Response; + + /** 506 Variant Also Negotiates + * + * Indicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation. + * + * The server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop. + * + * Used in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations. + * + * The server has a configuration error in content negotiation. The client should contact the server administrator. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2295 | RFC 2295} + */ + "506"?: Response; + + /** 507 Insufficient Storage + * + * Indicates that the server is unable to store the representation needed to complete the request. + * + * The server cannot store the representation required to complete the request, typically due to storage space limitations. + * + * Used in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms. + * + * The server cannot store the required representation. The client should check storage availability and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "507"?: Response; + + /** 508 Loop Detected + * + * Indicates that the server detected an infinite loop while processing the request. + * + * The server detected an infinite loop in the request processing, typically in WebDAV operations. + * + * Used in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios. + * + * The server detected an infinite loop. The client should check the request for circular references and retry. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} + */ + "508"?: Response; + + /** 510 Not Extended — OBSOLETED + * + * This status code is obsolete and should not be used in modern implementations. + * + * This status code was used for HTTP extensions but is now obsolete and should not be used. + * + * Not used in modern web applications. This code is obsolete and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2774 | RFC 2774 (Historic)} + * @see {@link https://datatracker.ietf.org/doc/status-change-http-experiments-to-historic/ | IETF: Status change of HTTP experiments to Historic} + */ + "510"?: Response; + + /** 511 Network Authentication Required + * + * Indicates that the client needs to authenticate to gain network access. + * + * The client must authenticate with the network before it can access the requested resource. + * + * Used in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication. + * + * The client needs to authenticate with the network. The client should follow the authentication process provided by the network. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "511"?: Response; + + //#endregion + + /** default — The default response for all codes not covered individually. */ + default?: Response; } diff --git a/3.1/tags.ts b/3.1/tags.ts index f46ac5a..24065a1 100644 --- a/3.1/tags.ts +++ b/3.1/tags.ts @@ -55,27 +55,27 @@ import type { ExternalDocumentation } from "./externalDocs"; * ``` */ export interface Tag extends Extension { - /** - * The name of the tag. This field is required. - * - * @example "users" - * @example "pets" - * @example "authentication" - */ - name: string; + /** + * The name of the tag. This field is required. + * + * @example "users" + * @example "pets" + * @example "authentication" + */ + name: string; - /** - * A short description for the tag. CommonMark syntax MAY be used for rich text representation. - * - * @example "User management operations" - * @example "Pet store operations" - */ - description?: string; + /** + * A short description for the tag. CommonMark syntax MAY be used for rich text representation. + * + * @example "User management operations" + * @example "Pet store operations" + */ + description?: string; - /** - * Additional external documentation for this tag. - * - * @example { description: "Find out more about user management", url: "https://example.com/docs/users" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for this tag. + * + * @example { description: "Find out more about user management", url: "https://example.com/docs/users" } + */ + externalDocs?: ExternalDocumentation; } diff --git a/3.1/xml.ts b/3.1/xml.ts index 20a9658..5a91c2a 100644 --- a/3.1/xml.ts +++ b/3.1/xml.ts @@ -74,52 +74,52 @@ import type { Extension } from "./extensions"; * ``` */ export interface XML extends Extension { - /** - * Replaces the name of the element/attribute used for the described schema property. - * When defined within the Items Object (items), it will affect the name of the individual - * XML elements within the list. When defined alongside type being array (outside the items), - * it will affect the wrapping element and only if wrapped is true. If wrapped is false, - * it will be ignored. - * - * @example "user" - * @example "id" - * @example "users" - */ - name?: string; + /** + * Replaces the name of the element/attribute used for the described schema property. + * When defined within the Items Object (items), it will affect the name of the individual + * XML elements within the list. When defined alongside type being array (outside the items), + * it will affect the wrapping element and only if wrapped is true. If wrapped is false, + * it will be ignored. + * + * @example "user" + * @example "id" + * @example "users" + */ + name?: string; - /** - * The URI of the namespace definition. This MUST be in the form of an absolute URI. - * - * @example "http://example.com/schema/user" - * @example "http://www.w3.org/XML/1998/namespace" - */ - namespace?: string; + /** + * The URI of the namespace definition. This MUST be in the form of an absolute URI. + * + * @example "http://example.com/schema/user" + * @example "http://www.w3.org/XML/1998/namespace" + */ + namespace?: string; - /** - * The prefix to be used for the name. - * - * @example "user" - * @example "xml" - */ - prefix?: string; + /** + * The prefix to be used for the name. + * + * @example "user" + * @example "xml" + */ + prefix?: string; - /** - * Declares whether the property definition translates to an attribute instead of an element. - * Default value is false. - * - * @example true - * @example false - */ - attribute?: boolean; + /** + * Declares whether the property definition translates to an attribute instead of an element. + * Default value is false. + * + * @example true + * @example false + */ + attribute?: boolean; - /** - * MAY be used only for an array definition. Signifies whether the array is wrapped - * (for example, ``) or unwrapped - * (for example, ``). Default value is false. The definition takes effect - * only when defined alongside type being array (outside the items). - * - * @example true - * @example false - */ - wrapped?: boolean; + /** + * MAY be used only for an array definition. Signifies whether the array is wrapped + * (for example, ``) or unwrapped + * (for example, ``). Default value is false. The definition takes effect + * only when defined alongside type being array (outside the items). + * + * @example true + * @example false + */ + wrapped?: boolean; } diff --git a/3.2/3.2.0.md b/3.2/3.2.0.md index 6ecea10..1163a09 100644 --- a/3.2/3.2.0.md +++ b/3.2/3.2.0.md @@ -92,19 +92,19 @@ This is the root object of the [OpenAPI Description](#openapi-description-struct In addition to the required fields, at least one of the `components`, `paths`, or `webhooks` fields MUST be present. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions-and-deprecation) of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the [`info.version`](#info-version) string, which describes the OpenAPI document's version. | -| $self | `string` | This string MUST be in the form of a URI reference as defined by [[RFC3986]] [Section 4.1](https://www.rfc-editor.org/rfc/rfc3986#section-4.1). The `$self` field provides the self-assigned URI of this document, which also serves as its base URI in accordance with [[RFC3986]] [Section 5.1.1](https://www.rfc-editor.org/rfc/rfc3986#section-5.1.1). Implementations MUST support identifying the targets of [API description URIs](#relative-references-in-api-description-uris) using the URI defined by this field when it is present. See [Establishing the Base URI](#establishing-the-base-uri) for the base URI behavior when `$self` is absent or relative, and see [Appendix F]((#appendix-f-examples-of-base-uri-determination-and-reference-resolution)) for examples of using `$self` to resolve references. | -| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | -| jsonSchemaDialect | `string` | The default value for the `$schema` keyword within [Schema Objects](#schema-object) contained within this OAS document. This MUST be in the form of a URI. | -| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` field is not provided, or is an empty array, the default value would be an array consisting of a single [Server Object](#server-object) with a [url](#server-url) value of `/`. | -| paths | [Paths Object](#paths-object) | The available paths and operations for the API. | -| webhooks | Map[`string`, [Path Item Object](#path-item-object)] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](https://learn.openapis.org/examples/v3.1/webhook-example.html) is available. | -| components | [Components Object](#components-object) | An element to hold various Objects for the OpenAPI Description. | -| security | [[Security Requirement Object](#security-requirement-object)] | 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. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement (`{}`) can be included in the array. | -| tags | [[Tag Object](#tag-object)] | A list of tags used by the OpenAPI Description 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](#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. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | +| Field Name | Type | Description | +| -------------------------------------------------------- | :-------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| openapi | `string` | **REQUIRED**. This string MUST be the [version number](#versions-and-deprecation) of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is _not_ related to the [`info.version`](#info-version) string, which describes the OpenAPI document's version. | +| $self | `string` | This string MUST be in the form of a URI reference as defined by [[RFC3986]] [Section 4.1](https://www.rfc-editor.org/rfc/rfc3986#section-4.1). The `$self` field provides the self-assigned URI of this document, which also serves as its base URI in accordance with [[RFC3986]] [Section 5.1.1](https://www.rfc-editor.org/rfc/rfc3986#section-5.1.1). Implementations MUST support identifying the targets of [API description URIs](#relative-references-in-api-description-uris) using the URI defined by this field when it is present. See [Establishing the Base URI](#establishing-the-base-uri) for the base URI behavior when `$self` is absent or relative, and see [Appendix F](<(#appendix-f-examples-of-base-uri-determination-and-reference-resolution)>) for examples of using `$self` to resolve references. | +| info | [Info Object](#info-object) | **REQUIRED**. Provides metadata about the API. The metadata MAY be used by tooling as required. | +| jsonSchemaDialect | `string` | The default value for the `$schema` keyword within [Schema Objects](#schema-object) contained within this OAS document. This MUST be in the form of a URI. | +| servers | [[Server Object](#server-object)] | An array of Server Objects, which provide connectivity information to a target server. If the `servers` field is not provided, or is an empty array, the default value would be an array consisting of a single [Server Object](#server-object) with a [url](#server-url) value of `/`. | +| paths | [Paths Object](#paths-object) | The available paths and operations for the API. | +| webhooks | Map[`string`, [Path Item Object](#path-item-object)] | The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement. Closely related to the `callbacks` feature, this section describes requests initiated other than by an API call, for example by an out of band registration. The key name is a unique string to refer to each webhook, while the (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the expected responses. An [example](https://learn.openapis.org/examples/v3.1/webhook-example.html) is available. | +| components | [Components Object](#components-object) | An element to hold various Objects for the OpenAPI Description. | +| security | [[Security Requirement Object](#security-requirement-object)] | 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. The list can be incomplete, up to being empty or absent. To make security explicitly optional, an empty security requirement (`{}`) can be included in the array. | +| tags | [[Tag Object](#tag-object)] | A list of tags used by the OpenAPI Description 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](#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. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -187,15 +187,15 @@ The metadata MAY be used by the clients if needed, and MAY be presented in editi #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| title | `string` | **REQUIRED**. The title of the API. | -| summary | `string` | A short summary of the API. | -| description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| termsOfService | `string` | A URI for the Terms of Service for the API. This MUST be in the form of a URI. | -| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | -| license | [License Object](#license-object) | The license information for the exposed API. | -| version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oas-version) or the version of the API being described or the version of the OpenAPI Description). | +| Field Name | Type | Description | +| -------------------------------------------------- | :-------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| title | `string` | **REQUIRED**. The title of the API. | +| summary | `string` | A short summary of the API. | +| description | `string` | A description of the API. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| termsOfService | `string` | A URI for the Terms of Service for the API. This MUST be in the form of a URI. | +| contact | [Contact Object](#contact-object) | The contact information for the exposed API. | +| license | [License Object](#license-object) | The license information for the exposed API. | +| version | `string` | **REQUIRED**. The version of the OpenAPI document (which is distinct from the [OpenAPI Specification version](#oas-version) or the version of the API being described or the version of the OpenAPI Description). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -222,10 +222,10 @@ Contact information for the exposed API. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | The identifying name of the contact person/organization. | -| url | `string` | The URI for the contact information. This MUST be in the form of a URI. | +| Field Name | Type | Description | +| --------------------------------- | :------: | --------------------------------------------------------------------------------------------------- | +| name | `string` | The identifying name of the contact person/organization. | +| url | `string` | The URI for the contact information. This MUST be in the form of a URI. | | email | `string` | The email address of the contact person/organization. This MUST be in the form of an email address. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -244,11 +244,11 @@ License information for the exposed API. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The license name used for the API. | -| identifier | `string` | An [SPDX](https://spdx.org/licenses/) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. | -| url | `string` | A URI for the license used for the API. This MUST be in the form of a URI. The `url` field is mutually exclusive of the `identifier` field. | +| Field Name | Type | Description | +| ------------------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The license name used for the API. | +| identifier | `string` | An [SPDX](https://spdx.org/licenses/) license expression for the API. The `identifier` field is mutually exclusive of the `url` field. | +| url | `string` | A URI for the license used for the API. This MUST be in the form of a URI. The `url` field is mutually exclusive of the `identifier` field. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -265,12 +265,12 @@ An object representing a Server. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Query and fragment MUST NOT be part of this URL. Variable substitutions will be made when a variable is named in `{`braces`}`. | -| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| name | `string` | An optional unique string to refer to the host designated by the URL. | -| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | +| Field Name | Type | Description | +| -------------------------------------------- | :--------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| url | `string` | **REQUIRED**. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the document containing the Server Object is being served. Query and fragment MUST NOT be part of this URL. Variable substitutions will be made when a variable is named in `{`braces`}`. | +| description | `string` | An optional string describing the host designated by the URL. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | An optional unique string to refer to the host designated by the URL. | +| variables | Map[`string`, [Server Variable Object](#server-variable-object)] | A map between a variable name and its value. The value is used for substitution in the server's URL template. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -294,10 +294,10 @@ info: title: Example API version: 1.0 servers: -- url: . - description: The production API on this device -- url: ./test - description: The test API on this device + - url: . + description: The production API on this device + - url: ./test + description: The test API on this device ``` For API URLs the `$self` field, which identifies the OpenAPI document, is ignored and the retrieval URI is used instead. This produces a normalized production URL of `https://device1.example.com`, and a normalized test URL of `https://device1.example.com/test`. @@ -341,9 +341,9 @@ servers: description: A user-specific subdomain. Use `demo` for a free sandbox environment. port: enum: - - '8443' - - '443' - default: '8443' + - "8443" + - "443" + default: "8443" basePath: # open meaning there is the opportunity to use special base paths as assigned by the provider, default is "v2" default: v2 @@ -384,11 +384,11 @@ See the [Paths Object](#paths-object) for guidance on constructing full request #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. | -| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. If the [`enum`](#server-variable-enum) is defined, the value MUST exist in the enum's values. Note that this behavior is different from the [Schema Object](#schema-object)'s `default` keyword, which documents the receiver's behavior rather than inserting the value into the data. | -| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| Field Name | Type | Description | +| ----------------------------------------------------- | :--------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| enum | [`string`] | An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. | +| default | `string` | **REQUIRED**. The default value to use for substitution, which SHALL be sent if an alternate value is _not_ supplied. If the [`enum`](#server-variable-enum) is defined, the value MUST exist in the enum's values. Note that this behavior is different from the [Schema Object](#schema-object)'s `default` keyword, which documents the receiver's behavior rather than inserting the value into the data. | +| description | `string` | An optional description for the server variable. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -399,19 +399,19 @@ All objects defined within the Components Object will have no effect on the API #### Fixed Fields -| Field Name | Type | Description | -| ---- | :---- | ---- | -| schemas | Map[`string`, [Schema Object](#schema-object)] | An object to hold reusable [Schema Objects](#schema-object). | -| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | -| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | -| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | -| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | +| Field Name | Type | Description | +| ---------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| schemas | Map[`string`, [Schema Object](#schema-object)] | An object to hold reusable [Schema Objects](#schema-object). | +| responses | Map[`string`, [Response Object](#response-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Response Objects](#response-object). | +| parameters | Map[`string`, [Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Parameter Objects](#parameter-object). | +| examples | Map[`string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Example Objects](#example-object). | +| requestBodies | Map[`string`, [Request Body Object](#request-body-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Request Body Objects](#request-body-object). | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Header Objects](#header-object). | | securitySchemes | Map[`string`, [Security Scheme Object](#security-scheme-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Security Scheme Objects](#security-scheme-object). | -| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | -| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | -| pathItems | Map[`string`, [Path Item Object](#path-item-object)] | An object to hold reusable [Path Item Objects](#path-item-object). | -| mediaTypes | Map[`string`, [Media Type Object](#media-type-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Media Type Objects](#media-type-object). | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Link Objects](#link-object). | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Callback Objects](#callback-object). | +| pathItems | Map[`string`, [Path Item Object](#path-item-object)] | An object to hold reusable [Path Item Objects](#path-item-object). | +| mediaTypes | Map[`string`, [Media Type Object](#media-type-object) \| [Reference Object](#reference-object)] | An object to hold reusable [Media Type Objects](#media-type-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -483,7 +483,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/GeneralError' + $ref: "#/components/schemas/GeneralError" securitySchemes: api_key: type: apiKey @@ -506,8 +506,8 @@ The path is appended to the URL from the [Server Object](#server-object) in orde #### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| -------------------------------- | :-----------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | /{path} | [Path Item Object](#path-item-object) | A relative path to an individual endpoint. The field name MUST begin with a forward slash (`/`). The URL from the [Server Object](#server-object)'s `url` field, resolved and with template variables substituted, has the path **appended** (no relative URL resolution) to it in order to construct the full URL. [Path templating](#path-templating) is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -573,14 +573,14 @@ The following may lead to ambiguous resolution: get: description: Returns all pets from the system that the user has access to responses: - '200': + "200": description: A list of pets. content: application/json: schema: type: array items: - $ref: '#/components/schemas/pet' + $ref: "#/components/schemas/pet" ``` ### Path Item Object @@ -591,23 +591,23 @@ The path itself is still exposed to the documentation viewer but they will not k #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| $ref | `string` | Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving [Relative References](#relative-references-in-api-description-uris).

_**Note:** The behavior of `$ref` with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the [Reference Object](#reference-object)._ | -| summary | `string` | An optional string summary, intended to apply to all operations in this path. | -| description | `string` | An optional string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | -| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | -| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | -| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | -| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | -| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | -| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | -| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | -| query | [Operation Object](#operation-object) | A definition of a QUERY operation, as defined in the most recent IETF draft ([draft-ietf-httpbis-safe-method-w-body-08](https://www.ietf.org/archive/id/draft-ietf-httpbis-safe-method-w-body-11.html) as of this writing) or its RFC successor, on this path. | -| additionalOperations | Map[`string`, [Operation Object](#operation-object)] | A map of additional operations on this path. The map key is the HTTP method with the same capitalization that is to be sent in the request. This map MUST NOT contain any entry for the methods that can be defined by other fixed fields with Operation Object values (e.g. no `POST` entry, as the `post` field is used for this method). | -| servers | [[Server Object](#server-object)] | An alternative `servers` array to service all operations in this path. If a `servers` array is specified at the [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | -| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | +| Field Name | Type | Description | +| ------------------------------------------------------------------ | :------------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a [Path Item Object](#path-item-object). In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving [Relative References](#relative-references-in-api-description-uris).

_**Note:** The behavior of `$ref` with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the [Reference Object](#reference-object)._ | +| summary | `string` | An optional string summary, intended to apply to all operations in this path. | +| description | `string` | An optional string description, intended to apply to all operations in this path. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| get | [Operation Object](#operation-object) | A definition of a GET operation on this path. | +| put | [Operation Object](#operation-object) | A definition of a PUT operation on this path. | +| post | [Operation Object](#operation-object) | A definition of a POST operation on this path. | +| delete | [Operation Object](#operation-object) | A definition of a DELETE operation on this path. | +| options | [Operation Object](#operation-object) | A definition of a OPTIONS operation on this path. | +| head | [Operation Object](#operation-object) | A definition of a HEAD operation on this path. | +| patch | [Operation Object](#operation-object) | A definition of a PATCH operation on this path. | +| trace | [Operation Object](#operation-object) | A definition of a TRACE operation on this path. | +| query | [Operation Object](#operation-object) | A definition of a QUERY operation, as defined in the most recent IETF draft ([draft-ietf-httpbis-safe-method-w-body-08](https://www.ietf.org/archive/id/draft-ietf-httpbis-safe-method-w-body-11.html) as of this writing) or its RFC successor, on this path. | +| additionalOperations | Map[`string`, [Operation Object](#operation-object)] | A map of additional operations on this path. The map key is the HTTP method with the same capitalization that is to be sent in the request. This map MUST NOT contain any entry for the methods that can be defined by other fixed fields with Operation Object values (e.g. no `POST` entry, as the `post` field is used for this method). | +| servers | [[Server Object](#server-object)] | An alternative `servers` array to service all operations in this path. If a `servers` array is specified at the [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | 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](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -619,20 +619,20 @@ get: summary: Find pets by ID operationId: getPetsById responses: - '200': + "200": description: pet response content: - '*/*': + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: text/html: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" parameters: - name: id in: path @@ -649,20 +649,20 @@ additionalOperations: summary: Copies pets by ID operationId: copyPetsById responses: - '200': + "200": description: pet response content: - '*/*': + "*/*": schema: type: array items: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: error payload content: text/html: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` ### Operation Object @@ -671,20 +671,20 @@ Describes a single API operation on a path. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | -| summary | `string` | A short summary of what the operation does. | -| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | -| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | -| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#path-item-parameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | -| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is fully supported in HTTP methods where the HTTP specification [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-9.3) has explicitly defined semantics for request bodies. In other cases where the HTTP spec discourages message content (such as [GET](https://www.rfc-editor.org/rfc/rfc9110.html#section-9.3.1) and [DELETE](https://www.rfc-editor.org/rfc/rfc9110.html#section-9.3.5)), `requestBody` is permitted but does not have well-defined semantics and SHOULD be avoided if possible. | -| responses | [Responses Object](#responses-object) | The list of possible responses as they are returned from executing this operation. | -| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. | -| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | -| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oas-security). To remove a top-level security declaration, an empty array can be used. | -| servers | [[Server Object](#server-object)] | An alternative `servers` array to service this operation. If a `servers` array is specified at the [Path Item Object](#path-item-servers) or [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | +| Field Name | Type | Description | +| -------------------------------------------------- | :-----------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. | +| summary | `string` | A short summary of what the operation does. | +| description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this operation. | +| operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is **case-sensitive**. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. | +| parameters | [[Parameter Object](#parameter-object) \| [Reference Object](#reference-object)] | A list of parameters that are applicable for this operation. If a parameter is already defined at the [Path Item](#path-item-parameters), the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a [name](#parameter-name) and [location](#parameter-in). The list can use the [Reference Object](#reference-object) to link to parameters that are defined in the [OpenAPI Object's `components.parameters`](#components-parameters). | +| requestBody | [Request Body Object](#request-body-object) \| [Reference Object](#reference-object) | The request body applicable for this operation. The `requestBody` is fully supported in HTTP methods where the HTTP specification [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-9.3) has explicitly defined semantics for request bodies. In other cases where the HTTP spec discourages message content (such as [GET](https://www.rfc-editor.org/rfc/rfc9110.html#section-9.3.1) and [DELETE](https://www.rfc-editor.org/rfc/rfc9110.html#section-9.3.5)), `requestBody` is permitted but does not have well-defined semantics and SHOULD be avoided if possible. | +| responses | [Responses Object](#responses-object) | The list of possible responses as they are returned from executing this operation. | +| callbacks | Map[`string`, [Callback Object](#callback-object) \| [Reference Object](#reference-object)] | A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a [Callback Object](#callback-object) that describes a request that may be initiated by the API provider and the expected responses. | +| deprecated | `boolean` | Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is `false`. | +| security | [[Security Requirement Object](#security-requirement-object)] | A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement (`{}`) can be included in the array. This definition overrides any declared top-level [`security`](#oas-security). To remove a top-level security declaration, an empty array can be used. | +| servers | [[Server Object](#server-object)] | An alternative `servers` array to service this operation. If a `servers` array is specified at the [Path Item Object](#path-item-servers) or [OpenAPI Object](#oas-servers) level, it will be overridden by this value. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -717,12 +717,12 @@ requestBody: required: - status responses: - '200': + "200": description: Pet updated. content: application/json: {} application/xml: {} - '405': + "405": description: Method Not Allowed content: application/json: {} @@ -739,10 +739,10 @@ Allows referencing an external resource for extended documentation. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| -------------------------------------------------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------- | | description | `string` | A description of the target documentation. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| url | `string` | **REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI. | +| url | `string` | **REQUIRED**. The URI for the target documentation. This MUST be in the form of a URI. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -765,11 +765,11 @@ See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a detail There are five possible parameter locations specified by the `in` field: -* path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. -* query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`; MUST NOT appear in the same operation (or in the operation's path-item) as an `in: "querystring"` parameter. -* querystring - A parameter that treats the entire URL query string as a value which MUST be specified using the `content` field, most often with media type `application/x-www-form-urlencoded` using [Encoding Objects](#encoding-object) in the same way as with request bodies of that media type; MUST NOT appear more than once, and MUST NOT appear in the same operation (or in the operation's path-item) as any `in: "query"` parameters. -* header - Custom headers that are expected as part of the request. Note that [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.1) states header names are case-insensitive. -* cookie - Used to pass a specific cookie value to the API. +- path - Used together with [Path Templating](#path-templating), where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API. For example, in `/items/{itemId}`, the path parameter is `itemId`. +- query - Parameters that are appended to the URL. For example, in `/items?id=###`, the query parameter is `id`; MUST NOT appear in the same operation (or in the operation's path-item) as an `in: "querystring"` parameter. +- querystring - A parameter that treats the entire URL query string as a value which MUST be specified using the `content` field, most often with media type `application/x-www-form-urlencoded` using [Encoding Objects](#encoding-object) in the same way as with request bodies of that media type; MUST NOT appear more than once, and MUST NOT appear in the same operation (or in the operation's path-item) as any `in: "query"` parameters. +- header - Custom headers that are expected as part of the request. Note that [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.1) states header names are case-insensitive. +- cookie - Used to pass a specific cookie value to the API. #### Fixed Fields @@ -783,16 +783,16 @@ These fields MAY be used with either `content` or `schema`. The `example` and `examples` fields are mutually exclusive; see [Working with Examples](#working-with-examples) for guidance on validation requirements. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case-sensitive_.
  • If [`in`](#parameter-in) is `"path"`, the `name` field MUST correspond to a single template expression occurring within the [path](#paths-path) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameter-in) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.
  • If `in` is `"querystring"`, or for [certain combinations](#style-examples) of [`style`](#parameter-style) and [`explode`](#parameter-explode), the value of `name` is not used in the parameter serialization.
  • For all other cases, the `name` corresponds to the parameter name used by the [`in`](#parameter-in) field.
| -| in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"querystring"`, `"header"`, `"path"` or `"cookie"`. | -| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameter-in) is `"path"`, this field is **REQUIRED** and its value MUST be `true`. Otherwise, the field MAY be included and its default value is `false`. | -| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | -| allowEmptyValue | `boolean` | If `true`, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is `false`. If [`style`](#parameter-style) is used, and if [behavior is _n/a_ (cannot be serialized)](#style-examples), the value of `allowEmptyValue` SHALL be ignored. Interactions between this field and the parameter's [Schema Object](#schema-object) are implementation-defined. This field is valid only for `query` parameters.

**Deprecated:** Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. | -| example | Any | Example of the parameter's potential value; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value; see [Working With Examples](#working-with-examples). | +| Field Name | Type | Description | +| ---------------------------------------------------------- | :----------------------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the parameter. Parameter names are _case-sensitive_.
  • If [`in`](#parameter-in) is `"path"`, the `name` field MUST correspond to a single template expression occurring within the [path](#paths-path) field in the [Paths Object](#paths-object). See [Path Templating](#path-templating) for further information.
  • If [`in`](#parameter-in) is `"header"` and the `name` field is `"Accept"`, `"Content-Type"` or `"Authorization"`, the parameter definition SHALL be ignored.
  • If `in` is `"querystring"`, or for [certain combinations](#style-examples) of [`style`](#parameter-style) and [`explode`](#parameter-explode), the value of `name` is not used in the parameter serialization.
  • For all other cases, the `name` corresponds to the parameter name used by the [`in`](#parameter-in) field.
| +| in | `string` | **REQUIRED**. The location of the parameter. Possible values are `"query"`, `"querystring"`, `"header"`, `"path"` or `"cookie"`. | +| description | `string` | A brief description of the parameter. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this parameter is mandatory. If the [parameter location](#parameter-in) is `"path"`, this field is **REQUIRED** and its value MUST be `true`. Otherwise, the field MAY be included and its default value is `false`. | +| deprecated | `boolean` | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| allowEmptyValue | `boolean` | If `true`, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is `false`. If [`style`](#parameter-style) is used, and if [behavior is _n/a_ (cannot be serialized)](#style-examples), the value of `allowEmptyValue` SHALL be ignored. Interactions between this field and the parameter's [Schema Object](#schema-object) are implementation-defined. This field is valid only for `query` parameters.

**Deprecated:** Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. | +| example | Any | Example of the parameter's potential value; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the parameter's potential value; see [Working With Examples](#working-with-examples). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -806,18 +806,18 @@ These fields MUST NOT be used with `in: "querystring"`. Care is needed for parameters with `schema` that have `in: "header"` or `in: "cookie", style: "cookie"`: -* When serializing these values, URI percent-encoding MUST NOT be applied. -* When parsing these parameters, any apparent percent-encoding MUST NOT be decoded. -* If using an RFC6570 implementation that automatically performs encoding or decoding steps, the steps MUST be undone before use. +- When serializing these values, URI percent-encoding MUST NOT be applied. +- When parsing these parameters, any apparent percent-encoding MUST NOT be decoded. +- If using an RFC6570 implementation that automatically performs encoding or decoding steps, the steps MUST be undone before use. In these cases, implementations MUST pass values through unchanged rather than attempting to quote or escape them, as the quoting rules for headers and escaping conventions for cookies vary too widely to be performed automatically; see [Appendix D](#appendix-d-serializing-headers-and-cookies) for guidance on quoting and escaping. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `"query"` - `"form"`; for `"path"` - `"simple"`; for `"header"` - `"simple"`; for `"cookie"` - `"form"` (for compatibility reasons; note that `style: "cookie"` SHOULD be used with `in: "cookie"`; see [Appendix D](#appendix-d-serializing-headers-and-cookies) for details). | -| explode | `boolean` | 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, or when [`style`](#parameter-style) is `"deepObject"`, this field has no effect. When `style` is `"form"` or `"cookie"`, the default value is `true`. For all other styles, the default value is `false`. | -| allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are not allowed by the rules of the `in` destination or media type, or are [not allowed in the path by this specification](#path-templating); see [URL Percent-Encoding](#url-percent-encoding) for details. The default value is `false`. This field only applies to `in` and `style` values that automatically percent-encode. | -| schema | [Schema Object](#schema-object) | The schema defining the type used for the parameter. | +| Field Name | Type | Description | +| ---------------------------------------------------- | :-----------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of `in`): for `"query"` - `"form"`; for `"path"` - `"simple"`; for `"header"` - `"simple"`; for `"cookie"` - `"form"` (for compatibility reasons; note that `style: "cookie"` SHOULD be used with `in: "cookie"`; see [Appendix D](#appendix-d-serializing-headers-and-cookies) for details). | +| explode | `boolean` | 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, or when [`style`](#parameter-style) is `"deepObject"`, this field has no effect. When `style` is `"form"` or `"cookie"`, the default value is `true`. For all other styles, the default value is `false`. | +| allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are not allowed by the rules of the `in` destination or media type, or are [not allowed in the path by this specification](#path-templating); see [URL Percent-Encoding](#url-percent-encoding) for details. The default value is `false`. This field only applies to `in` and `style` values that automatically percent-encode. | +| schema | [Schema Object](#schema-object) | The schema defining the type used for the parameter. | See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc6570-based-serialization) for additional guidance. @@ -827,24 +827,24 @@ For more complex scenarios, the [`content`](#parameter-content) field can define For use with `in: "querystring"` and `application/x-www-form-urlencoded`, see [Encoding the `x-www-form-urlencoded` Media Type](#encoding-the-x-www-form-urlencoded-media-type). -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| --------------------------------------- | :---------------------------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------- | | content | Map[`string`, [Media Type Object](#media-type-object) \| [Reference Object](#reference-object)] | 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. | #### Style Values In order to support common ways of serializing simple parameters, a set of `style` values are defined. Combinations not represented in this table are not permitted. -| `style` | [`type`](#data-types) | `in` | Comments | -| ---- | ---- | ---- | ---- | -| `matrix` | primitive, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | -| `label` | primitive, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | -| `simple` | primitive, `array`, `object` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | -| `form` | primitive, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | -| `spaceDelimited` | `array`, `object` | `query` | Space separated array values or object properties and values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | -| `pipeDelimited` | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | -| `deepObject` | `object` | `query` | Allows objects with scalar properties to be represented using form parameters. The representation of array or object properties is not defined (but see [Extending Support for Querystring Formats](#extending-support-for-querystring-formats) for alternatives). | -| `cookie` | primitive, `array`, `object` | `cookie` | Analogous to `form`, but following [[RFC6265]] `Cookie` syntax rules, meaning that name-value pairs are separated by a semicolon followed by a single space (e.g. `n1=v1; n2=v2`), and no percent-encoding or other escaping is applied; data values that require any sort of escaping MUST be provided in escaped form. | +| `style` | [`type`](#data-types) | `in` | Comments | +| ---------------- | ---------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `matrix` | primitive, `array`, `object` | `path` | Path-style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.7) | +| `label` | primitive, `array`, `object` | `path` | Label style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.5) | +| `simple` | primitive, `array`, `object` | `path`, `header` | Simple style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.2). This option replaces `collectionFormat` with a `csv` value from OpenAPI 2.0. | +| `form` | primitive, `array`, `object` | `query`, `cookie` | Form style parameters defined by [RFC6570](https://tools.ietf.org/html/rfc6570#section-3.2.8). This option replaces `collectionFormat` with a `csv` (when `explode` is false) or `multi` (when `explode` is true) value from OpenAPI 2.0. | +| `spaceDelimited` | `array`, `object` | `query` | Space separated array values or object properties and values. This option replaces `collectionFormat` equal to `ssv` from OpenAPI 2.0. | +| `pipeDelimited` | `array`, `object` | `query` | Pipe separated array values or object properties and values. This option replaces `collectionFormat` equal to `pipes` from OpenAPI 2.0. | +| `deepObject` | `object` | `query` | Allows objects with scalar properties to be represented using form parameters. The representation of array or object properties is not defined (but see [Extending Support for Querystring Formats](#extending-support-for-querystring-formats) for alternatives). | +| `cookie` | primitive, `array`, `object` | `cookie` | Analogous to `form`, but following [[RFC6265]] `Cookie` syntax rules, meaning that name-value pairs are separated by a semicolon followed by a single space (e.g. `n1=v1; n2=v2`), and no percent-encoding or other escaping is applied; data values that require any sort of escaping MUST be provided in escaped form. | #### URL Percent-Encoding @@ -856,9 +856,9 @@ These requirements are specified in terms of percent-_decoding_ rules, which are Percent-_encoding_ is performed in several places: -* By [[RFC6570]] implementations (or simulations thereof; see [Appendix C](#appendix-c-using-rfc6570-based-serialization)) -* By the Parameter or [Encoding](#encoding-object) Objects when incorporating a value serialized with a [Media Type Object](#media-type-object) for a media type that does not already incorporate URI percent-encoding -* By the user, prior to passing data through RFC6570's reserved expansion process +- By [[RFC6570]] implementations (or simulations thereof; see [Appendix C](#appendix-c-using-rfc6570-based-serialization)) +- By the Parameter or [Encoding](#encoding-object) Objects when incorporating a value serialized with a [Media Type Object](#media-type-object) for a media type that does not already incorporate URI percent-encoding +- By the user, prior to passing data through RFC6570's reserved expansion process When percent-encoding, the safest approach is to percent-encode all characters not in RFC3986's "unreserved" set, and for `form-urlencoded` to also percent-encode the tilde character (`~`) to align with historical requirements that are traced back to [[?RFC1738]], the URI RFC at the time `form-urlencoded` was created. This approach is used in examples in this specification. @@ -872,9 +872,9 @@ In some cases, such as inserting `/` into path parameter values, doing so is [ex See also: -* [Appendix C](#appendix-c-using-rfc6570-based-serialization) for guidance on using or simulating/extending RFC6570 implementations. -* [Appendix D](#appendix-d-serializing-headers-and-cookies) for guidance on percent-encoding and cookies, as well as other escaping approaches for headers and cookies. -* [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a thorough discussion of percent-encoding options, compatibility, and handling OAS-defined delimiters that are not allowed by RFC3986. +- [Appendix C](#appendix-c-using-rfc6570-based-serialization) for guidance on using or simulating/extending RFC6570 implementations. +- [Appendix D](#appendix-d-serializing-headers-and-cookies) for guidance on percent-encoding and cookies, as well as other escaping approaches for headers and cookies. +- [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a thorough discussion of percent-encoding options, compatibility, and handling OAS-defined delimiters that are not allowed by RFC3986. #### Serialization and Examples @@ -905,29 +905,29 @@ Assume a parameter named `color` has one of the following values, where the valu The following table shows serialized examples, as would be shown with the `serializedValue` field of an Example Object, of the different serializations for each value. -* The value _empty_ denotes the empty string, and is unrelated to the `allowEmptyValue` field. -* The behavior of combinations marked _n/a_ is undefined. -* The `undefined` column replaces the `empty` column in previous versions of this specification in order to better align with [RFC6570](https://www.rfc-editor.org/rfc/rfc6570.html#section-2.3) terminology, which describes certain values including but not limited to `null` as "undefined" values with special handling; notably, the empty string is _not_ undefined. -* For `form` and the non-RFC6570 query string styles `spaceDelimited`, `pipeDelimited`, and `deepObject`, see [Appendix C](#appendix-c-using-rfc6570-based-serialization) for more information on constructing query strings from multiple parameters, and [Appendix D](#appendix-d-serializing-headers-and-cookies) for warnings regarding `form` and `cookie` parameters. -* The examples are percent-encoded as explained in the [URL Percent-Encoding](#url-percent-encoding) section above; see [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a thorough discussion of percent-encoding concerns, including why unencoded `|` (`%7C`), `[` (`%5B`), and `]` (`%5D`) seem to work in some environments despite not being compliant. +- The value _empty_ denotes the empty string, and is unrelated to the `allowEmptyValue` field. +- The behavior of combinations marked _n/a_ is undefined. +- The `undefined` column replaces the `empty` column in previous versions of this specification in order to better align with [RFC6570](https://www.rfc-editor.org/rfc/rfc6570.html#section-2.3) terminology, which describes certain values including but not limited to `null` as "undefined" values with special handling; notably, the empty string is _not_ undefined. +- For `form` and the non-RFC6570 query string styles `spaceDelimited`, `pipeDelimited`, and `deepObject`, see [Appendix C](#appendix-c-using-rfc6570-based-serialization) for more information on constructing query strings from multiple parameters, and [Appendix D](#appendix-d-serializing-headers-and-cookies) for warnings regarding `form` and `cookie` parameters. +- The examples are percent-encoded as explained in the [URL Percent-Encoding](#url-percent-encoding) section above; see [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a thorough discussion of percent-encoding concerns, including why unencoded `|` (`%7C`), `[` (`%5B`), and `]` (`%5D`) seem to work in some environments despite not being compliant. -| [`style`](#style-values) | `explode` | `undefined` | `string` | `array` | `object` | -| ---- | ---- | ---- | ---- | ---- | ---- | -| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | -| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | -| label | false | . | .blue | .blue,black,brown | .R,100,G,200,B,150 | -| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | -| simple | false | _empty_ | blue | blue,black,brown | R,100,G,200,B,150 | -| simple | true | _empty_ | blue | blue,black,brown | R=100,G=200,B=150 | -| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | -| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | -| spaceDelimited | false | _n/a_ | _n/a_ | color=blue%20black%20brown | color=R%20100%20G%20200%20B%20150 | -| spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| pipeDelimited | false | _n/a_ | _n/a_ | color=blue%7Cblack%7Cbrown | color=R%7C100%7CG%7C200%7CB%7C150 | -| pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | -| deepObject | _n/a_ | _n/a_ | _n/a_ | _n/a_ | color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150 | -| cookie | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | -| cookie | true | color= | color=blue | color=blue; color=black; color=brown | R=100; G=200; B=150 | +| [`style`](#style-values) | `explode` | `undefined` | `string` | `array` | `object` | +| ------------------------ | --------- | ------------------------------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- | +| matrix | false | ;color | ;color=blue | ;color=blue,black,brown | ;color=R,100,G,200,B,150 | +| matrix | true | ;color | ;color=blue | ;color=blue;color=black;color=brown | ;R=100;G=200;B=150 | +| label | false | . | .blue | .blue,black,brown | .R,100,G,200,B,150 | +| label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150 | +| simple | false | _empty_ | blue | blue,black,brown | R,100,G,200,B,150 | +| simple | true | _empty_ | blue | blue,black,brown | R=100,G=200,B=150 | +| form | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| form | true | color= | color=blue | color=blue&color=black&color=brown | R=100&G=200&B=150 | +| spaceDelimited | false | _n/a_ | _n/a_ | color=blue%20black%20brown | color=R%20100%20G%20200%20B%20150 | +| spaceDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | +| pipeDelimited | false | _n/a_ | _n/a_ | color=blue%7Cblack%7Cbrown | color=R%7C100%7CG%7C200%7CB%7C150 | +| pipeDelimited | true | _n/a_ | _n/a_ | _n/a_ | _n/a_ | +| deepObject | _n/a_ | _n/a_ | _n/a_ | _n/a_ | color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150 | +| cookie | false | color= | color=blue | color=blue,black,brown | color=R,100,G,200,B,150 | +| cookie | true | color= | color=blue | color=blue; color=black; color=brown | R=100; G=200; B=150 | #### Extending Support for Querystring Formats @@ -936,8 +936,8 @@ Many frameworks define query string syntax for complex values, such as appending As these are not standards, and often contradict each other, the OAS does not attempt to support them directly. Two avenues are available for supporting such formats with `in: "querystring"`: -* Use `content` and `text/plain` with a schema of `type: "string"` and define the format outside of OpenAPI. While this requires more work to document and construct or parse the format, which is seen as a plain string from the OpenAPI perspective, it provides the easiest flexible option -* Define a media type (which need not necessarily be [IANA-registered](https://www.rfc-editor.org/rfc/rfc6838.html)) and a process for mapping in-memory data to the serialized media type. To increase the likelihood of support across multiple tools, submit a registration for the media type and process to the OpenAPI Initiative's [Media Type Registry](#openapi-media-type-registry). +- Use `content` and `text/plain` with a schema of `type: "string"` and define the format outside of OpenAPI. While this requires more work to document and construct or parse the format, which is seen as a plain string from the OpenAPI perspective, it provides the easiest flexible option +- Define a media type (which need not necessarily be [IANA-registered](https://www.rfc-editor.org/rfc/rfc6838.html)) and a process for mapping in-memory data to the serialized media type. To increase the likelihood of support across multiple tools, submit a registration for the media type and process to the OpenAPI Initiative's [Media Type Registry](#openapi-media-type-registry). #### Parameter Object Examples @@ -962,7 +962,6 @@ examples: serializedValue: "12345678,90099" ``` - A cookie parameter with an exploded object (the default for `style: "cookie"`): ```yaml @@ -980,10 +979,10 @@ schema: examples: Object: description: | - Note that the comma (,) has been pre-percent-encoded - to "%2C" in the data, as it is forbidden in - cookie values. However, the exclamation point (!) - is legal in cookies, so it can be left unencoded. + Note that the comma (,) has been pre-percent-encoded + to "%2C" in the data, as it is forbidden in + cookie values. However, the exclamation point (!) + is legal in cookies, so it can be left unencoded. dataValue: greeting: Hello%2C world! code: 42 @@ -1204,11 +1203,11 @@ Describes a single request body. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| content | Map[`string`, [Media Type Object](#media-type-object) \| [Reference Object](#reference-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://www.rfc-editor.org/rfc/rfc9110.html#appendix-A) and the value describes it. The map SHOULD have at least one entry; if it does not, the behavior is implementation-defined. For requests that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` | -| required | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | +| Field Name | Type | Description | +| -------------------------------------------------- | :---------------------------------------------------------------------------------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| description | `string` | A brief description of the request body. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| content | Map[`string`, [Media Type Object](#media-type-object) \| [Reference Object](#reference-object)] | **REQUIRED**. The content of the request body. The key is a media type or [media type range](https://www.rfc-editor.org/rfc/rfc9110.html#appendix-A) and the value describes it. The map SHOULD have at least one entry; if it does not, the behavior is implementation-defined. For requests that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` | +| required | `boolean` | Determines if the request body is required in the request. Defaults to `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1221,14 +1220,14 @@ description: user to add to the system content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User example externalValue: https://foo.bar/examples/user-example.json application/xml: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" examples: user: summary: User example in XML @@ -1238,7 +1237,7 @@ content: user: summary: User example in plain text externalValue: https://foo.bar/examples/user-example.txt - '*/*': + "*/*": examples: user: summary: User example in other format @@ -1256,15 +1255,15 @@ See [Working With Examples](#working-with-examples) for further guidance regardi #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| schema | [Schema Object](#schema-object) | A schema describing the complete content of the request, response, parameter, or header. | -| itemSchema | [Schema Object](#schema-object) | A schema describing each item within a [sequential media type](#sequential-media-types). | -| example | Any | Example of the media type; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type; see [Working With Examples](#working-with-examples). | -| encoding | Map[`string`, [Encoding Object](#encoding-object)] | A map between a property name and its encoding information, as defined under [Encoding By Name](#encoding-by-name). The `encoding` field SHALL only apply when the media type is `multipart` or `application/x-www-form-urlencoded`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. This field MUST NOT be present if `prefixEncoding` or `itemEncoding` are present. | -| prefixEncoding | [[Encoding Object](#encoding-object)] | An array of positional encoding information, as defined under [Encoding By Position](#encoding-by-position). The `prefixEncoding` field SHALL only apply when the media type is `multipart`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. This field MUST NOT be present if `encoding` is present. | -| itemEncoding | [Encoding Object](#encoding-object) | A single Encoding Object that provides encoding information for multiple array items, as defined under [Encoding By Position](#encoding-by-position). The `itemEncoding` field SHALL only apply when the media type is `multipart`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. This field MUST NOT be present if `encoding` is present. | +| Field Name | Type | Description | +| ------------------------------------------------------- | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| schema | [Schema Object](#schema-object) | A schema describing the complete content of the request, response, parameter, or header. | +| itemSchema | [Schema Object](#schema-object) | A schema describing each item within a [sequential media type](#sequential-media-types). | +| example | Any | Example of the media type; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the media type; see [Working With Examples](#working-with-examples). | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | A map between a property name and its encoding information, as defined under [Encoding By Name](#encoding-by-name). The `encoding` field SHALL only apply when the media type is `multipart` or `application/x-www-form-urlencoded`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. This field MUST NOT be present if `prefixEncoding` or `itemEncoding` are present. | +| prefixEncoding | [[Encoding Object](#encoding-object)] | An array of positional encoding information, as defined under [Encoding By Position](#encoding-by-position). The `prefixEncoding` field SHALL only apply when the media type is `multipart`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. This field MUST NOT be present if `encoding` is present. | +| itemEncoding | [Encoding Object](#encoding-object) | A single Encoding Object that provides encoding information for multiple array items, as defined under [Encoding By Position](#encoding-by-position). The `itemEncoding` field SHALL only apply when the media type is `multipart`. If no Encoding Object is provided for a property, the behavior is determined by the default values documented for the Encoding Object. This field MUST NOT be present if `encoding` is present. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1343,7 +1342,7 @@ The following Schema Object is a generic schema for the `text/event-stream` medi ```yaml type: object required: -- data + - data properties: data: type: string @@ -1409,7 +1408,7 @@ This avoids needing to embed JSON as a string. ```yaml application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" examples: cat: summary: An example of a cat @@ -1428,7 +1427,7 @@ application/json: gender: Female breed: Mixed frog: - $ref: '#/components/examples/frog-example' + $ref: "#/components/examples/frog-example" ``` Alternatively, since all JSON is valid YAML, the example value can use JSON syntax within a YAML document: @@ -1436,28 +1435,24 @@ Alternatively, since all JSON is valid YAML, the example value can use JSON synt ```yaml application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" examples: cat: summary: An example of a cat - value: { - "name": "Fluffy", - "petType": "Cat", - "color": "White", - "gender": "male", - "breed": "Persian" - } + value: + { + "name": "Fluffy", + "petType": "Cat", + "color": "White", + "gender": "male", + "breed": "Persian", + } dog: summary: An example of a dog with a cat's name - value: { - "name": "Puma", - "petType": "Dog", - "color": "Black", - "gender": "Female", - "breed": "Mixed" - } + value: + { "name": "Puma", "petType": "Dog", "color": "Black", "gender": "Female", "breed": "Mixed" } frog: - $ref: '#/components/examples/frog-example' + $ref: "#/components/examples/frog-example" ``` ##### Sequential JSON @@ -1582,36 +1577,36 @@ content: $ref: "#/components/schemas/Event" required: [event] oneOf: - - properties: - event: - const: addString - - properties: - event: - const: addInt64 - data: - $comment: | - Since the `data` field is a string, - we need a format to signal that it - should be handled as a 64-bit integer. - format: int64 - - properties: - event: - const: addJson - data: - $comment: | - These content fields indicate - that the string value should - be parsed and validated as a - JSON document (since JSON is not - a binary format, `contentEncoding` - is not needed) - contentMediaType: application/json - contentSchema: - type: object - required: [foo] - properties: - foo: - type: integer + - properties: + event: + const: addString + - properties: + event: + const: addInt64 + data: + $comment: | + Since the `data` field is a string, + we need a format to signal that it + should be handled as a 64-bit integer. + format: int64 + - properties: + event: + const: addJson + data: + $comment: | + These content fields indicate + that the string value should + be parsed and validated as a + JSON document (since JSON is not + a binary format, `contentEncoding` + is not needed) + contentMediaType: application/json + contentSchema: + type: object + required: [foo] + properties: + foo: + type: integer ``` The following `text/event-stream` document is an example of a valid request body for the above example: @@ -1704,13 +1699,13 @@ See [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for a detail These fields MAY be used either with or without the RFC6570-style serialization fields defined in the next section below. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| contentType | `string` | The `Content-Type` for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. `image/png`) or a wildcard media type (e.g. `image/*`). The default value depends on the type as shown in the table below. | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers. `Content-Type` is described separately and SHALL be ignored in this section. This field SHALL be ignored if the media type is not a `multipart`. | -| encoding | Map[`string`, [Encoding Object](#encoding-object)] | Applies nested Encoding Objects in the same manner as the [Media Type Object](#media-type-object)'s `encoding` field. | -| prefixEncoding | [[Encoding Object](#encoding-object)] | Applies nested Encoding Objects in the same manner as the [Media Type Object](#media-type-object)'s `prefixEncoding` field. | -| itemEncoding | [Encoding Object](#encoding-object) | Applies nested Encoding Objects in the same manner as the [Media Type Object](#media-type-object)'s `itemEncoding` field. | +| Field Name | Type | Description | +| ----------------------------------------------------- | :-------------------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| contentType | `string` | The `Content-Type` for encoding a specific property. The value is a comma-separated list, each element of which is either a specific media type (e.g. `image/png`) or a wildcard media type (e.g. `image/*`). The default value depends on the type as shown in the table below. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | A map allowing additional information to be provided as headers. `Content-Type` is described separately and SHALL be ignored in this section. This field SHALL be ignored if the media type is not a `multipart`. | +| encoding | Map[`string`, [Encoding Object](#encoding-object)] | Applies nested Encoding Objects in the same manner as the [Media Type Object](#media-type-object)'s `encoding` field. | +| prefixEncoding | [[Encoding Object](#encoding-object)] | Applies nested Encoding Objects in the same manner as the [Media Type Object](#media-type-object)'s `prefixEncoding` field. | +| itemEncoding | [Encoding Object](#encoding-object) | Applies nested Encoding Objects in the same manner as the [Media Type Object](#media-type-object)'s `itemEncoding` field. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -1719,14 +1714,14 @@ This table is based on the value to which the Encoding Object is being applied a Note that in the case of [Encoding By Name](#encoding-by-name), this value is the array item for properties of type `"array"`, and the entire value for all other types. Therefore the `array` row in this table applies only to array values inside of a top-level array when encoding by name. -| `type` | `contentEncoding` | Default `contentType` | -| ---- | ---- | ---- | -| [_absent_](#working-with-binary-data) | _n/a_ | `application/octet-stream` | -| `string` | _present_ | `application/octet-stream` | -| `string` | _absent_ | `text/plain` | -| `number`, `integer`, or `boolean` | _n/a_ | `text/plain` | -| `object` | _n/a_ | `application/json` | -| `array` | _n/a_ | `application/json` | +| `type` | `contentEncoding` | Default `contentType` | +| ------------------------------------- | ----------------- | -------------------------- | +| [_absent_](#working-with-binary-data) | _n/a_ | `application/octet-stream` | +| `string` | _present_ | `application/octet-stream` | +| `string` | _absent_ | `text/plain` | +| `number`, `integer`, or `boolean` | _n/a_ | `text/plain` | +| `object` | _n/a_ | `application/json` | +| `array` | _n/a_ | `application/json` | Determining how to handle a `type` value of `null` depends on how `null` values are being serialized. If `null` values are entirely omitted, then the `contentType` is irrelevant. @@ -1734,10 +1729,10 @@ See [Appendix B](#appendix-b-data-type-conversion) for a discussion of data type ##### Fixed Fields for RFC6570-style Serialization -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameter-style) field. The behavior follows the same values as `query` parameters, including the default value of `"form"` which applies only when `contentType` is _not_ being used due to one or both of `explode` or `allowReserved` being explicitly specified. Note that the initial `?` used in query strings is not used in `application/x-www-form-urlencoded` message bodies, and MUST be removed (if using an RFC6570 implementation) or simply not added (if constructing the string manually). This field SHALL be ignored if the media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | -| explode | `boolean` | When this is true, property 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 properties, or when [`style`](#encoding-style) is `"deepObject"`, this field has no effect. When `style` is `"form"`, the default value is `true`. For all other styles, the default value is `false`. This field SHALL be ignored if the media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | +| Field Name | Type | Description | +| --------------------------------------------------- | :-------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how a specific property value will be serialized depending on its type. See [Parameter Object](#parameter-object) for details on the [`style`](#parameter-style) field. The behavior follows the same values as `query` parameters, including the default value of `"form"` which applies only when `contentType` is _not_ being used due to one or both of `explode` or `allowReserved` being explicitly specified. Note that the initial `?` used in query strings is not used in `application/x-www-form-urlencoded` message bodies, and MUST be removed (if using an RFC6570 implementation) or simply not added (if constructing the string manually). This field SHALL be ignored if the media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | +| explode | `boolean` | When this is true, property 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 properties, or when [`style`](#encoding-style) is `"deepObject"`, this field has no effect. When `style` is `"form"`, the default value is `true`. For all other styles, the default value is `false`. This field SHALL be ignored if the media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | | allowReserved | `boolean` | When this is true, parameter values are serialized using reserved expansion, as defined by [RFC6570](https://datatracker.ietf.org/doc/html/rfc6570#section-3.2.3), which allows [RFC3986's reserved character set](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2), as well as percent-encoded triples, to pass through unchanged, while still percent-encoding all other disallowed characters (including `%` outside of percent-encoded triples). Applications are still responsible for percent-encoding reserved characters that are not allowed in the target media type; see [URL Percent-Encoding](#url-percent-encoding) for details. The default value is `false`. This field SHALL be ignored if the media type is not `application/x-www-form-urlencoded` or `multipart/form-data`. If a value is explicitly defined, then the value of [`contentType`](#encoding-content-type) (implicit or explicit) SHALL be ignored. | When using RFC6570-style serialization for `multipart/form-data`, URI percent-encoding MUST NOT be applied, and the value of `allowReserved` has no effect. @@ -1892,7 +1887,7 @@ requestBody: addresses: type: array items: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" ``` ##### Example: Multipart Form with Encoding Objects @@ -1918,7 +1913,7 @@ requestBody: description: addresses in XML format type: array items: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" # Encoding Object accepts only PNG or JPEG, and also describes # a custom header for just this part in the multipart format @@ -1963,27 +1958,27 @@ multipart/mixed: schema: type: array prefixItems: - - # default content type for objects - # is `application/json` - type: object - properties: - author: - type: string - created: - type: string - format: datetime - copyright: - type: string - license: - type: string - - # default content type for a schema without `type` - # is `application/octet-stream`, which we need - # to override. - {} + - # default content type for objects + # is `application/json` + type: object + properties: + author: + type: string + created: + type: string + format: datetime + copyright: + type: string + license: + type: string + - # default content type for a schema without `type` + # is `application/octet-stream`, which we need + # to override. + {} prefixEncoding: - - # Encoding Object defaults are correct for JSON - {} - - contentType: image/* + - # Encoding Object defaults are correct for JSON + {} + - contentType: image/* ``` ##### Example: Ordered Multipart With Required Header @@ -2013,25 +2008,25 @@ components: multipart/related; type=text/html: schema: prefixItems: - - type: string + - type: string items: anyOf: - - type: string - - $comment: To allow binary, this must always pass + - type: string + - $comment: To allow binary, this must always pass prefixEncoding: - - contentType: text/html - headers: - Content-ID: - $ref: '#/components/headers/RFC2557NoContentId' - Content-Location: - $ref: '#/components/headers/RFC2557ContentLocation' + - contentType: text/html + headers: + Content-ID: + $ref: "#/components/headers/RFC2557NoContentId" + Content-Location: + $ref: "#/components/headers/RFC2557ContentLocation" itemEncoding: contentType: text/css,text/javascript,image/* headers: Content-ID: - $ref: '#/components/headers/RFC2557NoContentId' + $ref: "#/components/headers/RFC2557NoContentId" Content-Location: - $ref: '#/components/headers/RFC2557ContentLocation' + $ref: "#/components/headers/RFC2557ContentLocation" ``` ##### Example: Streaming Multipart @@ -2080,19 +2075,19 @@ multipart/mixed: schema: type: array prefixItems: - - type: array - - type: array - prefixItems: - - type: object - - type: string - - {} + - type: array + - type: array + prefixItems: + - type: object + - type: string + - {} prefixEncoding: - {} # Accept the default application/json - contentType: multipart/mixed prefixEncoding: - - contentType: application/xml - - {} # Accept the default text/plain - - contentType: image/png + - contentType: application/xml + - {} # Accept the default text/plain + - contentType: image/png ``` ### Responses Object @@ -2112,14 +2107,14 @@ call. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| --------------------------------------- | :--------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------- | | default | [Response Object](#response-object) \| [Reference Object](#reference-object) | The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. | #### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ------------------------------------------------------------------- | :--------------------------------------------------------------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [HTTP Status Code](#http-status-codes) | [Response Object](#response-object) \| [Reference Object](#reference-object) | Any [HTTP status code](#http-status-codes) can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character `X`. For example, `2XX` represents all response codes between `200` and `299`. Only the following range definitions are allowed: `1XX`, `2XX`, `3XX`, `4XX`, and `5XX`. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2134,18 +2129,18 @@ Status codes SHOULD be selected from the available status codes registered in th A 200 response for a successful operation and a default response for others (implying an error): ```yaml -'200': +"200": description: a pet to be returned content: application/json: schema: - $ref: '#/components/schemas/Pet' + $ref: "#/components/schemas/Pet" default: description: Unexpected error content: application/json: schema: - $ref: '#/components/schemas/ErrorModel' + $ref: "#/components/schemas/ErrorModel" ``` ### Response Object @@ -2155,13 +2150,13 @@ Describes a single response from an API operation, including design-time, static #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| summary | `string` | A short summary of the meaning of the response. | -| description | `string` | A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.1) states header names are case-insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | -| content | Map[`string`, [Media Type Object](#media-type-object) \| [Reference Object](#reference-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://www.rfc-editor.org/rfc/rfc9110.html#appendix-A) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` | -| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | +| Field Name | Type | Description | +| ---------------------------------------------- | :---------------------------------------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | A short summary of the meaning of the response. | +| description | `string` | A description of the response. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| headers | Map[`string`, [Header Object](#header-object) \| [Reference Object](#reference-object)] | Maps a header name to its definition. [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-5.1) states header names are case-insensitive. If a response header is defined with the name `"Content-Type"`, it SHALL be ignored. | +| content | Map[`string`, [Media Type Object](#media-type-object) \| [Reference Object](#reference-object)] | A map containing descriptions of potential response payloads. The key is a media type or [media type range](https://www.rfc-editor.org/rfc/rfc9110.html#appendix-A) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. `"text/plain"` overrides `"text/*"` | +| links | Map[`string`, [Link Object](#link-object) \| [Reference Object](#reference-object)] | 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](#components-object). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2176,7 +2171,7 @@ content: schema: type: array items: - $ref: '#/components/schemas/VeryComplexType' + $ref: "#/components/schemas/VeryComplexType" ``` Response with a string type: @@ -2197,7 +2192,7 @@ content: text/plain: schema: type: string - example: 'whoa!' + example: "whoa!" headers: X-Rate-Limit-Limit: description: The number of allowed requests in the current period @@ -2229,8 +2224,8 @@ To describe incoming requests from the API provider independent from another API #### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ---------------------------------------------- | :-----------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | {expression} | [Path Item Object](#path-item-object) | A Path Item Object used to define a callback request and expected responses. A [complete example](https://learn.openapis.org/examples/v3.0/callback-example.html) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2269,16 +2264,16 @@ Location: https://example.org/subscription/1 The following examples show how the various expressions evaluate, assuming the callback operation has a path parameter named `eventType` and a query parameter named `queryUrl`. -| Expression | Value | -| ---- | :---- | -| $url | | -| $method | POST | -| $request.path.eventType | myevent | -| $request.query.queryUrl | | -| $request.header.content-type | application/json | -| $request.body#/failedUrl | | -| $request.body#/successUrls/1 | | -| $response.header.Location | | +| Expression | Value | +| ---------------------------- | :------------------------------------------------------------------------------------- | +| $url | | +| $method | POST | +| $request.path.eventType | myevent | +| $request.query.queryUrl | | +| $request.header.content-type | application/json | +| $request.body#/failedUrl | | +| $request.body#/successUrls/1 | | +| $response.header.Location | | #### Callback Object Examples @@ -2286,16 +2281,16 @@ The following example uses the user provided `queryUrl` query string parameter t ```yaml myCallback: - '{$request.query.queryUrl}': + "{$request.query.queryUrl}": post: requestBody: description: Callback payload content: application/json: schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` @@ -2303,16 +2298,16 @@ The following example shows a callback where the server is hard-coded, but the q ```yaml transactionCallback: - 'http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}': + "http://notificationServer.com?transactionId={$request.body#/id}&email={$request.body#/email}": post: requestBody: description: Callback payload content: application/json: schema: - $ref: '#/components/schemas/SomePayload' + $ref: "#/components/schemas/SomePayload" responses: - '200': + "200": description: callback successfully processed ``` @@ -2325,14 +2320,14 @@ The various fields and types of examples are explained in more detail under [Wor #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| summary | `string` | Short description for the example. | -| description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| dataValue | Any | An example of the data structure that MUST be valid according to the relevant [Schema Object](#schema-object). If this field is present, `value` MUST be absent. | -| serializedValue | `string` | An example of the serialized form of the value, including encoding and escaping as described under [Validating Examples](#validating-examples). If `dataValue` is present, then this field SHOULD contain the serialization of the given data. Otherwise, it SHOULD be the valid serialization of a data value that itself MUST be valid as described for `dataValue`. This field SHOULD NOT be used if the serialization format is JSON, as the data form is easier to work with. If this field is present, `value`, and `externalValue` MUST be absent. | -| externalValue | `string` | A URI that identifies the serialized example in a separate document, allowing for values not easily or readably expressed as a Unicode string. If `dataValue` is present, then this field SHOULD identify a serialization of the given data. Otherwise, the value SHOULD be the valid serialization of a data value that itself MUST be valid as described for `dataValue`. If this field is present, `serializedValue` and `value` MUST be absent. See also the rules for resolving [Relative References](#relative-references-in-api-description-uris). | -| value | Any | 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.

**Deprecated for non-JSON serialization targets:** Use `dataValue` and/or `serializedValue`, which both have unambiguous syntax and semantics, instead. | +| Field Name | Type | Description | +| ------------------------------------------------------ | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| summary | `string` | Short description for the example. | +| description | `string` | Long description for the example. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| dataValue | Any | An example of the data structure that MUST be valid according to the relevant [Schema Object](#schema-object). If this field is present, `value` MUST be absent. | +| serializedValue | `string` | An example of the serialized form of the value, including encoding and escaping as described under [Validating Examples](#validating-examples). If `dataValue` is present, then this field SHOULD contain the serialization of the given data. Otherwise, it SHOULD be the valid serialization of a data value that itself MUST be valid as described for `dataValue`. This field SHOULD NOT be used if the serialization format is JSON, as the data form is easier to work with. If this field is present, `value`, and `externalValue` MUST be absent. | +| externalValue | `string` | A URI that identifies the serialized example in a separate document, allowing for values not easily or readably expressed as a Unicode string. If `dataValue` is present, then this field SHOULD identify a serialization of the given data. Otherwise, the value SHOULD be the valid serialization of a data value that itself MUST be valid as described for `dataValue`. If this field is present, `serializedValue` and `value` MUST be absent. See also the rules for resolving [Relative References](#relative-references-in-api-description-uris). | +| value | Any | 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.

**Deprecated for non-JSON serialization targets:** Use `dataValue` and/or `serializedValue`, which both have unambiguous syntax and semantics, instead. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2364,16 +2359,16 @@ Keeping in mind the caveats from the previous section, and that the shorthand `e To show an example as it would be validated by a Schema Object: -* Use the Schema Object's `examples` array (from JSON Schema draft 2020-12) if the intent is to keep the example with the validating schema. - * Use the Schema Object's `example` (singular) only if compatibility with OAS v3.0 or earlier is required. -* Use the Example Object's `dataValue` field if the intent is to associate the example with an example of its serialization, or if it is desirable to maintain it separately from the schema. - * Use the Example Object's `value` field only if compatibility with OAS v3.1 or earlier is needed and the value can be "naturally represented in JSON or YAML" without any changes (such as percent-encoding) between the validation-ready value and the serialized representation. +- Use the Schema Object's `examples` array (from JSON Schema draft 2020-12) if the intent is to keep the example with the validating schema. + - Use the Schema Object's `example` (singular) only if compatibility with OAS v3.0 or earlier is required. +- Use the Example Object's `dataValue` field if the intent is to associate the example with an example of its serialization, or if it is desirable to maintain it separately from the schema. + - Use the Example Object's `value` field only if compatibility with OAS v3.1 or earlier is needed and the value can be "naturally represented in JSON or YAML" without any changes (such as percent-encoding) between the validation-ready value and the serialized representation. To show an example as it would be serialized in order to construct an HTTP/1.1 message: -* Use the Example Object's `serializedValue` if the serialization can be represented as a valid Unicode string, and there is no need to demonstrate the exact character encoding to be used. - * Use the string form of `value` only if compatibility with OAS v3.1 or earlier is needed. -* Use the Example Object's `externalValue` for all other values, or if it is desirable to maintain the example separately from the OpenAPI document. +- Use the Example Object's `serializedValue` if the serialization can be represented as a valid Unicode string, and there is no need to demonstrate the exact character encoding to be used. + - Use the string form of `value` only if compatibility with OAS v3.1 or earlier is needed. +- Use the Example Object's `externalValue` for all other values, or if it is desirable to maintain the example separately from the OpenAPI document. The `serializedValue` and `externalValue` fields both MUST show the serialized form of the data. For Media Type Objects, this is a document of the appropriate media type, with any Encoding Object effects applied. @@ -2383,9 +2378,9 @@ For Parameter and Header Objects using `schema` and `style` rather than a Media A serialization can be represented as a valid Unicode string in `serializedValue` if any of the following are true of the serialization: -* It is for a media type that supports a `charset` parameter that indicates any Unicode encoding (UTF-8, UTF-16, etc.), or any valid subset of such an encoding, such as US-ASCII. -* It is for a format (such as URIs or HTTP fields) or character-based media type that requires or defaults to a Unicode encoding, or any valid subset of such an encoding, such as US-ASCII, and this is not overridden by `charset`. -* It is for a compound format where all parts meet at least one of the above criteria, e.g. a `multipart/mixed` media type with parts that are `application/json` (a media type that defaults to UTF-8) and `application/xml; charset=utf-8` (a media type with an explicit `charset` parameter). +- It is for a media type that supports a `charset` parameter that indicates any Unicode encoding (UTF-8, UTF-16, etc.), or any valid subset of such an encoding, such as US-ASCII. +- It is for a format (such as URIs or HTTP fields) or character-based media type that requires or defaults to a Unicode encoding, or any valid subset of such an encoding, such as US-ASCII, and this is not overridden by `charset`. +- It is for a compound format where all parts meet at least one of the above criteria, e.g. a `multipart/mixed` media type with parts that are `application/json` (a media type that defaults to UTF-8) and `application/xml; charset=utf-8` (a media type with an explicit `charset` parameter). In all of these cases, the conversion from the character set of the OAD (presumed to be UTF-8 as the only interoperable character set for JSON, and therefore also for JSON-compatible YAML as noted in [[RFC9512]] [Section 3.4](https://www.rfc-editor.org/rfc/rfc9512.html#section-3.4)) first to Unicode code points and then to the actual serialization character set is well-defined. @@ -2413,8 +2408,8 @@ content: schema: type: object required: - - author - - title + - author + - title properties: author: type: string @@ -2488,14 +2483,14 @@ For computing links and providing instructions to execute them, a [runtime expre #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| operationRef | `string` | A URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI Description. | -| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | -| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. `path.id` for an `id` parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. | -| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | -| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| server | [Server Object](#server-object) | A server object to be used by the target operation. | +| Field Name | Type | Description | +| --------------------------------------------- | :--------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| operationRef | `string` | A URI reference to an OAS operation. This field is mutually exclusive of the `operationId` field, and MUST point to an [Operation Object](#operation-object). Relative `operationRef` values MAY be used to locate an existing [Operation Object](#operation-object) in the OpenAPI Description. | +| operationId | `string` | The name of an _existing_, resolvable OAS operation, as defined with a unique `operationId`. This field is mutually exclusive of the `operationRef` field. | +| parameters | Map[`string`, Any \| [{expression}](#runtime-expressions)] | A map representing parameters to pass to an operation as specified with `operationId` or identified via `operationRef`. The key is the parameter name to be used (optionally qualified with the parameter location, e.g. `path.id` for an `id` parameter in the path), whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. | +| requestBody | Any \| [{expression}](#runtime-expressions) | A literal value or [{expression}](#runtime-expressions) to use as a request body when calling the target operation. | +| description | `string` | A description of the link. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| server | [Server Object](#server-object) | A server object to be used by the target operation. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2524,7 +2519,7 @@ paths: type: string get: responses: - '200': + "200": description: the user being returned content: application/json: @@ -2554,7 +2549,7 @@ paths: get: operationId: getUserAddress responses: - '200': + "200": description: the user's address ``` @@ -2586,7 +2581,7 @@ A relative URI reference `operationRef`: links: UserRepositories: # returns array of '#/components/schemas/repository' - operationRef: '#/paths/~12.0~1repositories~1%7Busername%7D/get' + operationRef: "#/paths/~12.0~1repositories~1%7Busername%7D/get" parameters: username: $response.body#/username ``` @@ -2640,15 +2635,15 @@ The table below provides examples of runtime expressions and examples of their u ##### Example Expressions -| Source Location | example expression | notes | -| ---- | :---- | :---- | -| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | -| Requested media type | `$request.header.accept` | | -| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | -| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | -| Request URL | `$url` | | -| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | -| Response header | `$response.header.Server` | Single header values only are available | +| Source Location | example expression | notes | +| --------------------- | :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | +| HTTP Method | `$method` | The allowable values for the `$method` will be those for the HTTP operation. | +| Requested media type | `$request.header.accept` | | +| Request parameter | `$request.path.id` | Request parameters MUST be declared in the `parameters` section of the parent operation or they cannot be evaluated. This includes request headers. | +| Request body property | `$request.body#/user/uuid` | In operations which accept payloads, references may be made to portions of the `requestBody` or the entire body. | +| Request URL | `$url` | | +| Response value | `$response.body#/status` | In operations which return payloads, references may be made to portions of the response body or the entire body. | +| Response header | `$response.header.Server` | Single header values only are available | Runtime expressions preserve the type of the referenced value. Expressions can be embedded into string values by surrounding the expression with `{}` curly braces. @@ -2671,13 +2666,13 @@ These fields MAY be used with either `content` or `schema`. The `example` and `examples` fields are mutually exclusive; see [Working with Examples](#working-with-examples) for guidance on validation requirements. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| description | `string` | A brief description of the header. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| required | `boolean` | Determines whether this header is mandatory. The default value is `false`. | -| deprecated | `boolean` | Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | -| example | Any | Example of the header's potential value; see [Working With Examples](#working-with-examples). | -| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the header's potential value; see [Working With Examples](#working-with-examples). | +| Field Name | Type | Description | +| -------------------------------------------- | :----------------------------------------------------------------------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| description | `string` | A brief description of the header. This could contain examples of use. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| required | `boolean` | Determines whether this header is mandatory. The default value is `false`. | +| deprecated | `boolean` | Specifies that the header is deprecated and SHOULD be transitioned out of usage. Default value is `false`. | +| example | Any | Example of the header's potential value; see [Working With Examples](#working-with-examples). | +| examples | Map[ `string`, [Example Object](#example-object) \| [Reference Object](#reference-object)] | Examples of the header's potential value; see [Working With Examples](#working-with-examples). | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2688,11 +2683,11 @@ For simpler scenarios, a [`schema`](#header-schema) and [`style`](#header-style) When serializing headers with `schema`, URI percent-encoding MUST NOT be applied; if using an RFC6570 implementation that automatically applies it, it MUST be removed before use. Implementations MUST pass header values through unchanged rather than attempting to automatically quote header values, as the quoting rules vary too widely among different headers; see [Appendix D](#appendix-d-serializing-headers-and-cookies) for guidance on quoting and escaping. -| Field Name | Type | Description | -| ---- | :----: | ---- | -| style | `string` | Describes how the header value will be serialized. The default (and only legal value for headers) is `"simple"`. | -| explode | `boolean` | When this is true, header values of type `array` or `object` generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see [Style Examples](#style-examples). For other data types this field has no effect. The default value is `false`. | -| schema | [Schema Object](#schema-object) | The schema defining the type used for the header. | +| Field Name | Type | Description | +| ------------------------------------ | :-----------------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| style | `string` | Describes how the header value will be serialized. The default (and only legal value for headers) is `"simple"`. | +| explode | `boolean` | When this is true, header values of type `array` or `object` generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see [Style Examples](#style-examples). For other data types this field has no effect. The default value is `false`. | +| schema | [Schema Object](#schema-object) | The schema defining the type used for the header. | See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc6570-based-serialization) for additional guidance. @@ -2700,8 +2695,8 @@ See also [Appendix C: Using RFC6570-Based Serialization](#appendix-c-using-rfc65 For more complex scenarios, the [`content`](#header-content) field can define the media type and schema of the header, as well as give examples of its use. -| Field Name | Type | Description | -| ---- | :----: | ---- | +| Field Name | Type | Description | +| ------------------------------------ | :---------------------------------------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------- | | content | Map[`string`, [Media Type Object](#media-type-object) \| [Reference Object](#reference-object)] | A map containing the representations for the header. The key is the media type and the value describes it. The map MUST only contain one entry. | #### Modeling Link Headers @@ -2724,7 +2719,7 @@ components: items: type: object required: - - href + - href properties: href: type: string @@ -2732,7 +2727,7 @@ components: CollectionLinks: type: object required: - - linkset + - linkset properties: linkset: type: array @@ -2744,7 +2739,7 @@ components: type: string format: uri additionalProperties: - $ref: '#/components/schemas/SimpleLinkContext' + $ref: "#/components/schemas/SimpleLinkContext" responses: CollectionWithLinks: content: @@ -2757,12 +2752,12 @@ components: content: application/linkset: schema: - $ref: '#/components/schemas/CollectionLinks' + $ref: "#/components/schemas/CollectionLinks" StandaloneJsonLinkset: content: application/linkset+json: schema: - $ref: '#/components/mediaTypes/CollectionLinks' + $ref: "#/components/mediaTypes/CollectionLinks" ``` #### Representing the `Set-Cookie` Header @@ -2791,7 +2786,7 @@ However, because examples and values modeled with `content` do not incorporate t Note also that any URI percent-encoding, base64 encoding, or other escaping MUST be performed prior to supplying the data to OAS tooling; see [Appendix D](appendix-d-serializing-headers-and-cookies) for details. -The following example shows two different ways to describe `Set-Cookie` headers that require cookies named `"lang"` and `"foo"`, as well as a `"urlSafeData"` cookie that is expected to be percent-encoded. The first uses `content` in order to show exactly how such examples are formatted, but also notes the limitations of schema constraints with multi-line text. The second shows the use of `style: "simple"`, which produces the same serialized example text (with each line corresponding to one `Set-Cookie:` line in the HTTP response), but allows schema constraints on each cookie; note that the percent-encoding is already applied in the `dataValue` field of the example: +The following example shows two different ways to describe `Set-Cookie` headers that require cookies named `"lang"` and `"foo"`, as well as a `"urlSafeData"` cookie that is expected to be percent-encoded. The first uses `content` in order to show exactly how such examples are formatted, but also notes the limitations of schema constraints with multi-line text. The second shows the use of `style: "simple"`, which produces the same serialized example text (with each line corresponding to one `Set-Cookie:` line in the HTTP response), but allows schema constraints on each cookie; note that the percent-encoding is already applied in the `dataValue` field of the example: ```yaml components: @@ -2892,14 +2887,14 @@ It is not mandatory to have a Tag Object per tag defined in the Operation Object #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| name | `string` | **REQUIRED**. The name of the tag. Use this value in the `tags` array of an Operation. | -| summary | `string` | A short summary of the tag, used for display purposes. | -| description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | -| parent | `string` | The `name` of a tag that this tag is nested under. The named tag MUST exist in the API description, and circular references between parent and child tags MUST NOT be used. | -| kind | `string` | A machine-readable string to categorize what sort of tag it is. Any string value can be used; common uses are `nav` for Navigation, `badge` for visible badges, `audience` for APIs used by different groups. A [registry of the most commonly used values](https://spec.openapis.org/registry/tag-kind/) is available. | +| Field Name | Type | Description | +| -------------------------------------------- | :-------------------------------------------------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | `string` | **REQUIRED**. The name of the tag. Use this value in the `tags` array of an Operation. | +| summary | `string` | A short summary of the tag, used for display purposes. | +| description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | +| parent | `string` | The `name` of a tag that this tag is nested under. The named tag MUST exist in the API description, and circular references between parent and child tags MUST NOT be used. | +| kind | `string` | A machine-readable string to categorize what sort of tag it is. Any string value can be used; common uses are `nav` for Navigation, `badge` for visible badges, `audience` for APIs used by different groups. A [registry of the most commonly used values](https://spec.openapis.org/registry/tag-kind/) is available. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -2934,10 +2929,10 @@ See the rules for resolving [Relative References](#relative-references-in-api-de #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| $ref | `string` | **REQUIRED**. The reference identifier. This MUST be in the form of a URI. | -| summary | `string` | A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. | +| Field Name | Type | Description | +| ----------------------------------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| $ref | `string` | **REQUIRED**. The reference identifier. This MUST be in the form of a URI. | +| summary | `string` | A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a `summary` field, then this field has no effect. | | description | `string` | A description which by default SHOULD override that of the referenced component. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. If the referenced object-type does not allow a `description` field, then this field has no effect. | This object cannot be extended with additional properties, and any properties added SHALL be ignored. @@ -2947,7 +2942,7 @@ Note that this restriction on additional properties is a difference between Refe #### Reference Object Example ```yaml -$ref: '#/components/schemas/Pet' +$ref: "#/components/schemas/Pet" ``` #### Relative Schema Document Example @@ -2980,8 +2975,8 @@ The OpenAPI Schema Object dialect for this version of the specification is ident The following keywords are taken from the JSON Schema specification but their definitions have been extended by the OAS: -* description - [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. -* format - See [Data Type Formats](#data-type-format) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats. +- description - [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. +- format - See [Data Type Formats](#data-type-format) for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats. In addition to the JSON Schema keywords comprising the OAS dialect, the Schema Object supports keywords from any other vocabularies, or entirely arbitrary properties. @@ -2990,12 +2985,12 @@ JSON Schema implementations MAY choose to treat keywords defined by the OpenAPI #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| discriminator | [Discriminator Object](#discriminator-object) | The discriminator provides a "hint" for which of a set of schemas a payload is expected to satisfy. See [Composition and Inheritance](#composition-and-inheritance-polymorphism) for more details. | -| xml | [XML Object](#xml-object) | Adds additional metadata to describe the XML representation of this schema. | -| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | -| example | Any | A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.

**Deprecated:** The `example` field has been deprecated in favor of the JSON Schema `examples` keyword. Use of `example` is discouraged, and later versions of this specification may remove it. | +| Field Name | Type | Description | +| ------------------------------------------------ | :-------------------------------------------------------------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| discriminator | [Discriminator Object](#discriminator-object) | The discriminator provides a "hint" for which of a set of schemas a payload is expected to satisfy. See [Composition and Inheritance](#composition-and-inheritance-polymorphism) for more details. | +| xml | [XML Object](#xml-object) | Adds additional metadata to describe the XML representation of this schema. | +| externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this schema. | +| example | Any | A free-form field to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.

**Deprecated:** The `example` field has been deprecated in favor of the JSON Schema `examples` keyword. Use of `example` is discouraged, and later versions of this specification may remove it. | This object MAY be extended with [Specification Extensions](#specification-extensions), though as noted, additional properties MAY omit the `x-` prefix within this object. @@ -3020,13 +3015,13 @@ For the purpose of [JSON Schema validation](https://www.ietf.org/archive/id/draf The formats defined by the OAS are: -| `format` | JSON Data Type | Comments | -| ---- | ---- | ---- | -| `int32` | number | signed 32 bits | -| `int64` | number | signed 64 bits (a.k.a long) | -| `float` | number | | -| `double` | number | | -| `password` | string | A hint to obscure the value. | +| `format` | JSON Data Type | Comments | +| ---------- | -------------- | ---------------------------- | +| `int32` | number | signed 32 bits | +| `int64` | number | signed 64 bits (a.k.a long) | +| `float` | number | | +| `double` | number | | +| `password` | string | A hint to obscure the value. | As noted under [Data Type](#data-types), both `type: number` and `type: integer` are considered to be numbers in the data model. @@ -3076,18 +3071,18 @@ For example, if an implementation opts to inspect `anyOf`, the schema: ```yaml anyOf: -- type: number - minimum: 0 -- type: number - maximum: 100 + - type: number + minimum: 0 + - type: number + maximum: 100 ``` unambiguously indicates a numeric type, but the schema: ```yaml anyOf: -- type: number -- maximum: 100 + - type: number + - maximum: 100 ``` does not, because the second subschema allows all types. @@ -3115,11 +3110,11 @@ components: properties: code: allOf: - - type: [string, number] - pattern: "1" - minimum: 0 - - type: string - pattern: "2" + - type: [string, number] + pattern: "1" + minimum: 0 + - type: string + pattern: "2" count: type: integer extra: @@ -3134,13 +3129,13 @@ code=1234&count=42&extra=%3Cinfo%3Eabc%3C/info%3E We must first search the schema for `properties` or other property-defining keywords, and then use each property schema as a starting point for a search for that property's `type` keyword, as follows (the exact order is implementation-defined): -* `#/components/requestBodies/Form/content/application~1x-www-form-urlencoded/schema` (initial starting point schema, only `$ref`) -* `#/components/schemas/FormData` (follow `$ref`, found `properties`) -* `#/components/schemas/FormData/properties/code` (starting point schema for `code` property) -* `#/components/schemas/FormData/properties/code/allOf/0` (follow `allOf`, found `type: [string, number]`) -* `#/components/schemas/FormData/properties/code/allOf/1` (follow `allOf`, found `type: string`) -* `#/components/schemas/FormData/properties/count` (starting point schema for `count` property, found `type: integer`) -* `#/components/schemas/FormData/properties/extra` (starting point schema for `extra` property, found `type: object`) +- `#/components/requestBodies/Form/content/application~1x-www-form-urlencoded/schema` (initial starting point schema, only `$ref`) +- `#/components/schemas/FormData` (follow `$ref`, found `properties`) +- `#/components/schemas/FormData/properties/code` (starting point schema for `code` property) +- `#/components/schemas/FormData/properties/code/allOf/0` (follow `allOf`, found `type: [string, number]`) +- `#/components/schemas/FormData/properties/code/allOf/1` (follow `allOf`, found `type: string`) +- `#/components/schemas/FormData/properties/count` (starting point schema for `count` property, found `type: integer`) +- `#/components/schemas/FormData/properties/extra` (starting point schema for `extra` property, found `type: object`) Note that for `code` we first found an ambiguous `type`, but then found another `type` keyword that ensures only one of the two possibilities is valid. @@ -3168,16 +3163,16 @@ However, the `extra` field is an object, which would by default be serialized as The OAS can describe either _raw_ or _encoded_ binary data. -* **raw binary** is used where unencoded binary data is allowed, such as when sending a binary payload as the entire HTTP message body, or as part of a `multipart/*` payload that allows binary parts -* **encoded binary** is used where binary data is embedded in a text-only format such as `application/json` or `application/x-www-form-urlencoded` (either as a message body or in the URL query string). +- **raw binary** is used where unencoded binary data is allowed, such as when sending a binary payload as the entire HTTP message body, or as part of a `multipart/*` payload that allows binary parts +- **encoded binary** is used where binary data is embedded in a text-only format such as `application/json` or `application/x-www-form-urlencoded` (either as a message body or in the URL query string). In the following table showing how to use Schema Object keywords for binary data, we use `image/png` as an example binary media type. Any binary media type, including `application/octet-stream`, is sufficient to indicate binary content. -| Keyword | Raw | Encoded | Comments | -| ---- | ---- | ---- | ---- | -| `type` | _omit_ | `string` | raw binary is [outside of `type`](https://www.ietf.org/archive/id/draft-bhutton-json-schema-01.html#section-4.2.3) | -| `contentMediaType` | `image/png` | `image/png` | can sometimes be omitted if redundant (see below) | -| `contentEncoding` | _omit_ | `base64` or `base64url` | other encodings are [allowed](https://www.ietf.org/archive/id/draft-bhutton-json-schema-validation-01.html#section-8.3) | +| Keyword | Raw | Encoded | Comments | +| ------------------ | ----------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `type` | _omit_ | `string` | raw binary is [outside of `type`](https://www.ietf.org/archive/id/draft-bhutton-json-schema-01.html#section-4.2.3) | +| `contentMediaType` | `image/png` | `image/png` | can sometimes be omitted if redundant (see below) | +| `contentEncoding` | _omit_ | `base64` or `base64url` | other encodings are [allowed](https://www.ietf.org/archive/id/draft-bhutton-json-schema-validation-01.html#section-8.3) | Note that the encoding indicated by `contentEncoding`, which inflates the size of data in order to represent it as 7-bit ASCII text, is unrelated to HTTP's `Content-Encoding` header, which indicates whether and how a message body has been compressed and is applied after all content serialization described in this section has occurred. Since HTTP allows unencoded binary message bodies, there is no standardized HTTP header for indicating base64 or similar encoding of an entire message body. @@ -3185,8 +3180,8 @@ Using a `contentEncoding` of `base64url` ensures that URL encoding (as required The `contentMediaType` keyword is redundant if the media type is already set: -* as the key for a [Media Type Object](#media-type-object) -* in the `contentType` field of an [Encoding Object](#encoding-object) +- as the key for a [Media Type Object](#media-type-object) +- in the `contentType` field of an [Encoding Object](#encoding-object) If the [Schema Object](#schema-object) will be processed by a non-OAS-aware JSON Schema implementation, it may be useful to include `contentMediaType` even if it is redundant. However, if `contentMediaType` contradicts a relevant Media Type Object or Encoding Object, then `contentMediaType` SHALL be ignored. @@ -3208,10 +3203,10 @@ However, `multipart` media types can mix binary and text-based data, leaving imp The following table shows how to migrate from OAS 3.0 binary data descriptions, continuing to use `image/png` as the example binary media type: -| OAS < 3.1 | OAS >= 3.1 | Comments | -| ---- | ---- | ---- | -| type: string
format: binary | contentMediaType: image/png | if redundant, can be omitted, often resulting in an empty [Schema Object](#schema-object) | -| type: string
format: byte | type: string
contentMediaType: image/png
contentEncoding: base64 | note that `base64url` can be used to avoid re-encoding the base64 string to be URL-safe | +| OAS < 3.1 | OAS >= 3.1 | Comments | +| ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| type: string
format: binary | contentMediaType: image/png | if redundant, can be omitted, often resulting in an empty [Schema Object](#schema-object) | +| type: string
format: byte | type: string
contentMediaType: image/png
contentEncoding: base64 | note that `base64url` can be used to avoid re-encoding the base64 string to be URL-safe | #### Extended Validation with Annotations @@ -3255,15 +3250,15 @@ The discriminating property MAY be defined as required or optional, but when def There are two ways to define the value of a discriminating property for an inheriting instance. -* Use the schema name. -* [Override the schema name](#discriminator-mapping) by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. +- Use the schema name. +- [Override the schema name](#discriminator-mapping) by overriding the property with a new value. If a new value exists, this takes precedence over the schema name. ##### Generic (Template) Data Structures Implementations SHOULD support defining generic or template data structures using JSON Schema's dynamic referencing feature: -* `$dynamicAnchor` identifies a set of possible schemas (including a default placeholder schema) to which a `$dynamicRef` can resolve -* `$dynamicRef` resolves to the first matching `$dynamicAnchor` encountered on its path from the schema entry point to the reference, as described in the JSON Schema specification +- `$dynamicAnchor` identifies a set of possible schemas (including a default placeholder schema) to which a `$dynamicRef` can resolve +- `$dynamicRef` resolves to the first matching `$dynamicAnchor` encountered on its path from the schema entry point to the reference, as described in the JSON Schema specification An example is included in the [Schema Object Examples](#schema-object-examples) section below, and further information can be found on the Learn OpenAPI site's ["Dynamic References"](https://learn.openapis.org/referencing/dynamic.html) page. @@ -3308,7 +3303,7 @@ properties: name: type: string address: - $ref: '#/components/schemas/Address' + $ref: "#/components/schemas/Address" age: type: integer format: int32 @@ -3330,7 +3325,7 @@ For a string to model mapping: ```yaml type: object additionalProperties: - $ref: '#/components/schemas/ComplexModel' + $ref: "#/components/schemas/ComplexModel" ``` ##### Model with Annotated Enumeration @@ -3381,7 +3376,7 @@ components: maximum: 600 ExtendedErrorModel: allOf: - - $ref: '#/components/schemas/ErrorModel' + - $ref: "#/components/schemas/ErrorModel" - type: object required: - rootCause @@ -3406,14 +3401,14 @@ components: - name - petType oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" Cat: description: A pet cat type: object properties: petType: - const: 'cat' + const: "cat" huntingSkill: type: string description: The measured skill for hunting @@ -3429,7 +3424,7 @@ components: type: object properties: petType: - const: 'dog' + const: "dog" packSize: type: integer format: int32 @@ -3452,8 +3447,8 @@ components: discriminator: propertyName: petType mapping: - cat: '#/components/schemas/Cat' - dog: '#/components/schemas/Dog' + cat: "#/components/schemas/Cat" + dog: "#/components/schemas/Dog" properties: name: type: string @@ -3461,14 +3456,14 @@ components: - name - petType oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" Cat: description: A pet cat type: object properties: petType: - const: 'cat' + const: "cat" huntingSkill: type: string description: The measured skill for hunting @@ -3484,7 +3479,7 @@ components: type: object properties: petType: - const: 'dog' + const: "dog" packSize: type: integer format: int32 @@ -3518,7 +3513,7 @@ components: Cat: # "Cat" will be used as the discriminating value description: A representation of a cat allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object properties: huntingSkill: @@ -3534,7 +3529,7 @@ components: Dog: # "Dog" will be used as the discriminating value description: A representation of a dog allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object properties: packSize: @@ -3556,7 +3551,7 @@ components: $id: fully_generic_array type: array items: - $dynamicRef: '#generic-array' + $dynamicRef: "#generic-array" $defs: allowAll: $dynamicAnchor: generic-array @@ -3578,24 +3573,24 @@ components: $id: obj_with_typed_array type: object required: - - dataType - - data + - dataType + - data properties: dataType: enum: - - string - - number + - string + - number oneOf: - - properties: - dataType: - const: string - data: - $ref: array_of_strings - - properties: - dataType: - const: number - data: - $ref: array_of_numbers + - properties: + dataType: + const: string + data: + $ref: array_of_strings + - properties: + dataType: + const: number + data: + $ref: array_of_numbers ``` ### Discriminator Object @@ -3610,11 +3605,11 @@ Note that `discriminator` MUST NOT change the validation outcome of the schema. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| propertyName | `string` | **REQUIRED**. The name of the discriminating property in the payload that will hold the discriminating value. The discriminating property MAY be defined as required or optional, but when defined as optional the Discriminator Object MUST include a `defaultMapping` field that specifies which schema is expected to validate the structure of the model when the discriminating property is not present. | -| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or URI references. | -| defaultMapping | `string` | The schema name or URI reference to a schema that is expected to validate the structure of the model when the discriminating property is not present in the payload or contains a value for which there is no explicit or implicit mapping. | +| Field Name | Type | Description | +| ----------------------------------------------------------- | :---------------------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| propertyName | `string` | **REQUIRED**. The name of the discriminating property in the payload that will hold the discriminating value. The discriminating property MAY be defined as required or optional, but when defined as optional the Discriminator Object MUST include a `defaultMapping` field that specifies which schema is expected to validate the structure of the model when the discriminating property is not present. | +| mapping | Map[`string`, `string`] | An object to hold mappings between payload values and schema names or URI references. | +| defaultMapping | `string` | The schema name or URI reference to a schema that is expected to validate the structure of the model when the discriminating property is not present in the payload or contains a value for which there is no explicit or implicit mapping. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -3658,7 +3653,7 @@ OtherPet: properties: petType: not: - enum: ['cat', 'dog'] + enum: ["cat", "dog"] ``` This prevents the `defaultMapping` schema from validating a payload that includes the discriminating property with a mapped discriminating value, which would cause a validation to fail when polymorphism is described using the `oneOf` JSON schema keyword. @@ -3672,9 +3667,9 @@ In OAS 3.x, a response payload MAY be described to be exactly one of any number ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" ``` which means a valid payload has to match exactly one of the schemas described by `Cat`, `Dog`, or `Lizard`. Deserialization of a `oneOf` can be a costly operation, as it requires determining which schema matches the payload and thus should be used in deserialization. This problem also exists for `anyOf` schemas. A `discriminator` can be used as a "hint" to improve the efficiency of selection of the matching schema. The [Discriminator Object](#discriminator-object) cannot change the validation result of the `oneOf`, it can only help make the deserialization more efficient and provide better error messaging. We can specify the exact field that tells us which schema is expected to match the instance: @@ -3682,9 +3677,9 @@ which means a valid payload has to match exactly one of the schemas described by ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" discriminator: propertyName: petType ``` @@ -3705,14 +3700,14 @@ In scenarios where the value of the discriminating property does not match the s ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" - $ref: https://gigantic-server.com/schemas/Monster/schema.json discriminator: propertyName: petType mapping: - dog: '#/components/schemas/Dog' + dog: "#/components/schemas/Dog" monster: https://gigantic-server.com/schemas/Monster/schema.json ``` @@ -3727,10 +3722,10 @@ For example: ```yaml MyResponseType: oneOf: - - $ref: '#/components/schemas/Cat' - - $ref: '#/components/schemas/Dog' - - $ref: '#/components/schemas/Lizard' - - $ref: '#/components/schemas/OtherPet' + - $ref: "#/components/schemas/Cat" + - $ref: "#/components/schemas/Dog" + - $ref: "#/components/schemas/Lizard" + - $ref: "#/components/schemas/OtherPet" discriminator: propertyName: petType defaultMapping: OtherPet @@ -3739,7 +3734,7 @@ OtherPet: properties: petType: not: - enum: ['Cat', 'Dog', 'Lizard'] + enum: ["Cat", "Dog", "Lizard"] ``` In this example, if the `petType` property is not present in the payload, or if the value of `petType` is not "Cat", "Dog", or "Lizard", then the payload should validate against the `OtherPet` schema. @@ -3762,7 +3757,7 @@ components: dog: Dog Cat: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Cat` properties: @@ -3770,7 +3765,7 @@ components: type: string Dog: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Dog` properties: @@ -3778,7 +3773,7 @@ components: type: string Lizard: allOf: - - $ref: '#/components/schemas/Pet' + - $ref: "#/components/schemas/Pet" - type: object # all other properties specific to a `Lizard` properties: @@ -3813,14 +3808,14 @@ When using a Schema Object with XML, if no XML Object is present, the behavior i #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| nodeType | `string` | One of `element`, `attribute`, `text`, `cdata`, or `none`, as explained under [XML Node Types](#xml-node-types). The default value is `none` if `$ref`, `$dynamicRef`, or `type: "array"` is present in the [Schema Object](#schema-object) containing the XML Object, and `element` otherwise. | -| name | `string` | Sets the name of the element/attribute corresponding to the schema, replacing the name that was inferred as described under [XML Node Names](#xml-node-names). This field SHALL be ignored if the `nodeType` is `text`, `cdata`, or `none`. | -| namespace | `string` | The IRI ([[RFC3987]]) of the namespace definition. Value MUST be in the form of a non-relative IRI. | -| prefix | `string` | The prefix to be used for the [name](#xml-name). | -| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. If `nodeType` is present, this field MUST NOT be present.

**Deprecated:** Use `nodeType: "attribute"` instead of `attribute: true` | -| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `"array"` (outside the `items`). If `nodeType` is present, this field MUST NOT be present.

**Deprecated:** Use `nodeType: "element"` instead of `wrapped: true` | +| Field Name | Type | Description | +| ------------------------------------- | :-------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| nodeType | `string` | One of `element`, `attribute`, `text`, `cdata`, or `none`, as explained under [XML Node Types](#xml-node-types). The default value is `none` if `$ref`, `$dynamicRef`, or `type: "array"` is present in the [Schema Object](#schema-object) containing the XML Object, and `element` otherwise. | +| name | `string` | Sets the name of the element/attribute corresponding to the schema, replacing the name that was inferred as described under [XML Node Names](#xml-node-names). This field SHALL be ignored if the `nodeType` is `text`, `cdata`, or `none`. | +| namespace | `string` | The IRI ([[RFC3987]]) of the namespace definition. Value MUST be in the form of a non-relative IRI. | +| prefix | `string` | The prefix to be used for the [name](#xml-name). | +| attribute | `boolean` | Declares whether the property definition translates to an attribute instead of an element. Default value is `false`. If `nodeType` is present, this field MUST NOT be present.

**Deprecated:** Use `nodeType: "attribute"` instead of `attribute: true` | +| wrapped | `boolean` | MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (``). Default value is `false`. The definition takes effect only when defined alongside `type` being `"array"` (outside the `items`). If `nodeType` is present, this field MUST NOT be present.

**Deprecated:** Use `nodeType: "element"` instead of `wrapped: true` | Note that when generating an XML document from object data, the order of the nodes is undefined. Use `prefixItems` to control node ordering as shown under [Ordered Elements and Text](#ordered-elements-and-text). @@ -3834,11 +3829,11 @@ This object MAY be extended with [Specification Extensions](#specification-exten Each Schema Object describes a particular type of XML [[!DOM]] [node](https://dom.spec.whatwg.org/#interface-node) which is specified by the `nodeType` field, which has the following possible values. Except for the special value `none`, these values have numeric equivalents in the DOM specification which are given in parentheses after the name: -* `element` (1): The schema represents an element and describes its contents -* `attribute` (2): The schema represents an attribute and describes its value -* `text` (3): The schema represents a text node (parsed character data) -* `cdata` (4): The schema represents a CDATA section -* `none`: The schema does not correspond to any node in the XML document, and the nodes corresponding to its subschema(s) are included directly under its parent schema's node +- `element` (1): The schema represents an element and describes its contents +- `attribute` (2): The schema represents an attribute and describes its value +- `text` (3): The schema represents a text node (parsed character data) +- `cdata` (4): The schema represents a CDATA section +- `none`: The schema does not correspond to any node in the XML document, and the nodes corresponding to its subschema(s) are included directly under its parent schema's node The `none` type is useful for JSON Schema constructs that require more Schema Objects than XML nodes, such as a schema containing only `$ref` that exists to facilitate re-use rather than imply any structure. @@ -3863,9 +3858,9 @@ Note that placing two `text` nodes adjacent to each other is ambiguous for parsi The `element` and `attribute` node types require a name, which MUST be inferred from the schema as follows, unless overridden by the `name` field: -* For schemas directly under the [Components Object's](#components-object) `schemas` field, the component name is the inferred name. -* For property schemas, and for array item schemas under a property schema, the property name is the inferred name. -* In all other cases, such as an inline schema under a [Media Type Object's](#media-type-object) `schema` field, no name can be inferred and an XML Object with a `name` field MUST be present. +- For schemas directly under the [Components Object's](#components-object) `schemas` field, the component name is the inferred name. +- For property schemas, and for array item schemas under a property schema, the property name is the inferred name. +- In all other cases, such as an inline schema under a [Media Type Object's](#media-type-object) `schema` field, no name can be inferred and an XML Object with a `name` field MUST be present. Note that when using arrays, singular vs plural forms are _not_ inferred, and must be set explicitly. @@ -3873,8 +3868,8 @@ Note that when using arrays, singular vs plural forms are _not_ inferred, and mu The `namespace` field is intended to match the syntax of [XML namespaces](https://www.w3.org/TR/xml-names11/), although there are a few caveats: -* Versions 3.1.0, 3.0.3, and earlier of this specification erroneously used the term "absolute URI" instead of "non-relative URI" ("non-relative IRI" as of OAS v3.2.0), so authors using namespaces that include a fragment should check tooling support carefully. -* XML allows but discourages relative IRI-references, while this specification outright forbids them. +- Versions 3.1.0, 3.0.3, and earlier of this specification erroneously used the term "absolute URI" instead of "non-relative URI" ("non-relative IRI" as of OAS v3.2.0), so authors using namespaces that include a fragment should check tooling support carefully. +- XML allows but discourages relative IRI-references, while this specification outright forbids them. #### Handling `null` Values @@ -3882,9 +3877,9 @@ XML does not, by default, have a concept equivalent to `null`, and to preserve c However, implementations SHOULD handle `null` values as follows: -* For elements, produce an empty element with an `xsi:nil="true"` attribute. -* For attributes, omit the attribute. -* For text and CDATA sections, see [Appendix B](#appendix-b-data-type-conversion) for a discussion of serializing non-text values to text. +- For elements, produce an empty element with an `xsi:nil="true"` attribute. +- For attributes, omit the attribute. +- For text and CDATA sections, see [Appendix B](#appendix-b-data-type-conversion) for a discussion of serializing non-text values to text. Note that for attributes, this makes either a `null` value or a missing property serialize to an omitted attribute. As the Schema Object validates the in-memory representation, this allows handling the combination of `null` and a required property. @@ -4280,10 +4275,10 @@ application/xml: examples: pets: dataValue: - - kind: Cat - name: Fluffy - - kind: Dog - name: Fido + - kind: Cat + name: Fluffy + - kind: Dog + name: Fido ``` Where `./examples/pets.xml` would be: @@ -4297,7 +4292,7 @@ Where `./examples/pets.xml` would be: ##### Referenced Element With CDATA -In this example, no element is created for the Schema Object that contains only the `$ref`, as its `nodeType` defaults to `none`. +In this example, no element is created for the Schema Object that contains only the `$ref`, as its `nodeType` defaults to `none`. It is necessary to create a subschema for the CDATA section as otherwise the content would be treated as an implicit node of type `text`. ```yaml @@ -4470,15 +4465,15 @@ application/xml: name: Report type: array prefixItems: - - xml: - nodeType: text - type: string - - xml: - name: data - type: number - - xml: - nodeType: text - type: string + - xml: + nodeType: text + type: string + - xml: + name: data + type: number + - xml: + nodeType: text + type: string examples: Report: dataValue: @@ -4507,14 +4502,14 @@ application/xml: name: product type: object required: - - count - - description - - related + - count + - description + - related properties: count: type: - - number - - "null" + - number + - "null" xml: nodeType: attribute rating: @@ -4525,8 +4520,8 @@ application/xml: type: string related: type: - - object - - "null" + - object + - "null" examples: productWithNulls: dataValue: @@ -4569,18 +4564,18 @@ Please note that as of 2020, the implicit flow is about to be deprecated by [OAu #### Fixed Fields -| Field Name | Type | Applies To | Description | -| ---- | :----: | ---- | ---- | -| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"mutualTLS"`, `"oauth2"`, `"openIdConnect"`. | -| description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | -| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | -| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"`, or `"cookie"`. | -| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authentication scheme to be used in the [Authorization header as defined in RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-16.4.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). The value is case-insensitive, as defined in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-11.1). | -| bearerFormat | `string` | `http` (`"bearer"`) | 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. | -| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | -| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. [Well-known URL](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) to discover the [[OpenID-Connect-Discovery]] [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | -| oauth2MetadataUrl | `string` | `oauth2` | URL to the OAuth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required. | -| deprecated | `boolean` | Any | Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Default value is `false`. | +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------------- | :---------------------------------------: | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| type | `string` | Any | **REQUIRED**. The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"mutualTLS"`, `"oauth2"`, `"openIdConnect"`. | +| description | `string` | Any | A description for security scheme. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | +| name | `string` | `apiKey` | **REQUIRED**. The name of the header, query or cookie parameter to be used. | +| in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"`, or `"cookie"`. | +| scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authentication scheme to be used in the [Authorization header as defined in RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-16.4.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml). The value is case-insensitive, as defined in [RFC9110](https://www.rfc-editor.org/rfc/rfc9110.html#section-11.1). | +| bearerFormat | `string` | `http` (`"bearer"`) | 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. | +| flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. | +| openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. [Well-known URL](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) to discover the [[OpenID-Connect-Discovery]] [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). | +| oauth2MetadataUrl | `string` | `oauth2` | URL to the OAuth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required. | +| deprecated | `boolean` | Any | Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Default value is `false`. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -4634,13 +4629,13 @@ Allows configuration of the supported OAuth Flows. #### Fixed Fields -| Field Name | Type | Description | -| ---- | :----: | ---- | -| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | -| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | -| clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | -| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | -| deviceAuthorization | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Device Authorization flow. | +| Field Name | Type | Description | +| ------------------------------------------------------------------ | :-------------------------------------: | ---------------------------------------------------------------------------------------------------- | +| implicit | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Implicit flow | +| password | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Resource Owner Password flow | +| clientCredentials | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Client Credentials flow. Previously called `application` in OpenAPI 2.0. | +| authorizationCode | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Authorization Code flow. Previously called `accessCode` in OpenAPI 2.0. | +| deviceAuthorization | [OAuth Flow Object](#oauth-flow-object) | Configuration for the OAuth Device Authorization flow. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -4650,13 +4645,13 @@ Configuration details for a supported OAuth Flow #### Fixed Fields -| Field Name | Type | Applies To | Description | -| ---- | :----: | ---- | ---- | -| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| deviceAuthorizationUrl | `string` | `oauth2` (`"deviceAuthorization"`) | **REQUIRED**. The device authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`, `"deviceAuthorization"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | -| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | +| Field Name | Type | Applies To | Description | +| ------------------------------------------------------------------------ | :---------------------: | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | +| authorizationUrl | `string` | `oauth2` (`"implicit"`, `"authorizationCode"`) | **REQUIRED**. The authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| deviceAuthorizationUrl | `string` | `oauth2` (`"deviceAuthorization"`) | **REQUIRED**. The device authorization URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| tokenUrl | `string` | `oauth2` (`"password"`, `"clientCredentials"`, `"authorizationCode"`, `"deviceAuthorization"`) | **REQUIRED**. The token URL to be used for this flow. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| refreshUrl | `string` | `oauth2` | The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL. The OAuth2 standard requires the use of TLS. | +| scopes | Map[`string`, `string`] | `oauth2` | **REQUIRED**. The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it. The map MAY be empty. | This object MAY be extended with [Specification Extensions](#specification-extensions). @@ -4698,8 +4693,8 @@ An empty Security Requirement Object (`{}`) indicates anonymous access is suppor #### Patterned Fields -| Field Pattern | Type | Description | -| ---- | :----: | ---- | +| Field Pattern | Type | Description | +| ----------------------------------------------- | :--------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | {name} | [`string`] | Each name or URI MUST correspond to a security scheme as described above. If the security scheme is of type `"oauth2"` or `"openIdConnect"`, then the value is a list of scope names required for the execution, and the list MAY be empty if authorization does not require a specified scope. For other security scheme types, the array MAY contain a list of role names which are required for the execution, but are not otherwise defined or exchanged in-band. | #### Security Requirement Object Examples @@ -4742,9 +4737,9 @@ While the OpenAPI Specification tries to accommodate most use cases, additional The extensions properties are implemented as patterned fields that are always prefixed by `x-`. -| Field Pattern | Type | Description | -| ---- | :--: | ---- | -| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. Field names beginning `x-oai-` and `x-oas-` are reserved for uses defined by the [OpenAPI Initiative](https://www.openapis.org/). The value can be any valid JSON value (`null`, a primitive, an array, or an object.) | +| Field Pattern | Type | Description | +| -------------------------------------- | :--: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. Field names beginning `x-oai-` and `x-oas-` are reserved for uses defined by the [OpenAPI Initiative](https://www.openapis.org/). The value can be any valid JSON value (`null`, a primitive, an array, or an object.) | The OpenAPI Initiative maintains several [[OpenAPI-Registry|extension registries]], including registries for [individual extension keywords](https://spec.openapis.org/registry/extension/) and [extension keyword namespaces](https://spec.openapis.org/registry/namespace/). @@ -4759,10 +4754,10 @@ Support for any one extension is OPTIONAL, and support for one extension does no OpenAPI Descriptions use a combination of JSON, YAML, and JSON Schema, and therefore share their security considerations: -* [JSON](https://www.iana.org/assignments/media-types/application/json) -* [YAML](https://www.iana.org/assignments/media-types/application/yaml) -* [JSON Schema Core](https://www.ietf.org/archive/id/draft-bhutton-json-schema-01.html#section-13) -* [JSON Schema Validation](https://www.ietf.org/archive/id/draft-bhutton-json-schema-validation-01.html#section-10) +- [JSON](https://www.iana.org/assignments/media-types/application/json) +- [YAML](https://www.iana.org/assignments/media-types/application/yaml) +- [JSON Schema Core](https://www.ietf.org/archive/id/draft-bhutton-json-schema-01.html#section-13) +- [JSON Schema Validation](https://www.ietf.org/archive/id/draft-bhutton-json-schema-validation-01.html#section-10) ### Tooling and Usage Scenarios @@ -4774,8 +4769,8 @@ An OpenAPI Description describes the security schemes used to protect the resour The rules for connecting a [Security Requirement Object](#security-requirement-object) to a [Security Scheme Object](#security-scheme-object) under a [Components Object](#components-object) are ambiguous in a way that could be exploited. Specifically: -* It is implementation-defined whether a component name used by a Security Requirement Object in a referenced document is resolved from the entry document (RECOMMENDED) or the referenced document. -* A Security Requirement Object that uses a URI to identify a Security Scheme Object can have the URI resolution hijacked by providing a Security Scheme component name identical to the URI, as the name lookup behavior takes precedence over URI resolution for compatibility with previous versions of the OAS. +- It is implementation-defined whether a component name used by a Security Requirement Object in a referenced document is resolved from the entry document (RECOMMENDED) or the referenced document. +- A Security Requirement Object that uses a URI to identify a Security Scheme Object can have the URI resolution hijacked by providing a Security Scheme component name identical to the URI, as the name lookup behavior takes precedence over URI resolution for compatibility with previous versions of the OAS. ### Security Filtering @@ -4803,27 +4798,27 @@ Certain fields allow the use of Markdown which can contain HTML including script ## Appendix A: Revision History -| Version | Date | Notes | -| ---- | ---- | ---- | -| 3.2.0 | 2025-09-19 | Release of the OpenAPI Specification 3.2.0 | -| 3.1.2 | 2025-09-19 | Patch release of the OpenAPI Specification 3.1.2 | -| 3.1.1 | 2024-10-24 | Patch release of the OpenAPI Specification 3.1.1 | -| 3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0 | -| 3.1.0-rc1 | 2020-10-08 | rc1 of the 3.1 specification | -| 3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification | -| 3.0.4 | 2024-10-24 | Patch release of the OpenAPI Specification 3.0.4 | -| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | -| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | -| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | -| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | -| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | -| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | -| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | -| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | -| 2.0 | 2014-09-08 | Release of Swagger 2.0 | -| 1.2 | 2014-03-14 | Initial release of the formal document. | -| 1.1 | 2012-08-22 | Release of Swagger 1.1 | -| 1.0 | 2011-08-10 | First release of the Swagger Specification | +| Version | Date | Notes | +| --------- | ---------- | ------------------------------------------------- | +| 3.2.0 | 2025-09-19 | Release of the OpenAPI Specification 3.2.0 | +| 3.1.2 | 2025-09-19 | Patch release of the OpenAPI Specification 3.1.2 | +| 3.1.1 | 2024-10-24 | Patch release of the OpenAPI Specification 3.1.1 | +| 3.1.0 | 2021-02-15 | Release of the OpenAPI Specification 3.1.0 | +| 3.1.0-rc1 | 2020-10-08 | rc1 of the 3.1 specification | +| 3.1.0-rc0 | 2020-06-18 | rc0 of the 3.1 specification | +| 3.0.4 | 2024-10-24 | Patch release of the OpenAPI Specification 3.0.4 | +| 3.0.3 | 2020-02-20 | Patch release of the OpenAPI Specification 3.0.3 | +| 3.0.2 | 2018-10-08 | Patch release of the OpenAPI Specification 3.0.2 | +| 3.0.1 | 2017-12-06 | Patch release of the OpenAPI Specification 3.0.1 | +| 3.0.0 | 2017-07-26 | Release of the OpenAPI Specification 3.0.0 | +| 3.0.0-rc2 | 2017-06-16 | rc2 of the 3.0 specification | +| 3.0.0-rc1 | 2017-04-27 | rc1 of the 3.0 specification | +| 3.0.0-rc0 | 2017-02-28 | Implementer's Draft of the 3.0 specification | +| 2.0 | 2015-12-31 | Donation of Swagger 2.0 to the OpenAPI Initiative | +| 2.0 | 2014-09-08 | Release of Swagger 2.0 | +| 1.2 | 2014-03-14 | Initial release of the formal document. | +| 1.1 | 2012-08-22 | Release of Swagger 1.1 | +| 1.0 | 2011-08-10 | First release of the Swagger Specification | ## Appendix B: Data Type Conversion @@ -4838,8 +4833,8 @@ However, there is no general-purpose specification for converting schema-validat Two cases do offer standards-based guidance: -* [RFC3987](https://datatracker.ietf.org/doc/html/rfc3987#section-3.1) provides guidance for converting non-Unicode strings to UTF-8, particularly in the context of URIs (and by extension, the form media types which use the same encoding rules) -* [RFC6570](https://www.rfc-editor.org/rfc/rfc6570#section-2.3) specifies which values, including but not limited to `null`, are considered _undefined_ and therefore treated specially in the expansion process when serializing based on that specification +- [RFC3987](https://datatracker.ietf.org/doc/html/rfc3987#section-3.1) provides guidance for converting non-Unicode strings to UTF-8, particularly in the context of URIs (and by extension, the form media types which use the same encoding rules) +- [RFC6570](https://www.rfc-editor.org/rfc/rfc6570#section-2.3) specifies which values, including but not limited to `null`, are considered _undefined_ and therefore treated specially in the expansion process when serializing based on that specification Implementations of RFC6570 often have their own conventions for converting non-string values, but these are implementation-specific and not defined by the RFC itself. This is one reason for the OpenAPI Specification to leave these conversions as implementation-defined: It allows using RFC6570 implementations regardless of how they choose to perform the conversions. @@ -4857,11 +4852,11 @@ Requiring input as pre-formatted, schema-validated strings also improves round-t Serialization is defined in terms of [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) URI Templates in three scenarios: -| Object | Condition | -| ---- | ---- | -| [Parameter Object](#parameter-object) | When `schema` is present | -| [Header Object](#header-object) | When `schema` is present | -| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used | +| Object | Condition | +| ------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| [Parameter Object](#parameter-object) | When `schema` is present | +| [Header Object](#header-object) | When `schema` is present | +| [Encoding Object](#encoding-object) | When encoding for `application/x-www-form-urlencoded` and any of `style`, `explode`, or `allowReserved` are used | Implementations of this specification MAY use an implementation of RFC6570 to perform variable expansion, however, some caveats apply. @@ -4878,30 +4873,30 @@ Using an implementation with a lower level of support will require additional ma Certain field values translate to RFC6570 [operators](https://datatracker.ietf.org/doc/html/rfc6570#section-2.2) (or lack thereof): -| field | value | equivalent | -| ---- | ---- | ---- | -| style | `"simple"` | _n/a_ | -| style | `"matrix"` | `;` prefix operator | -| style | `"label"` | `.` prefix operator | -| style | `"form"` | `?` prefix operator | -| allowReserved | `false` | _n/a_ | -| allowReserved | `true` | `+` prefix operator | -| explode | `false` | _n/a_ | -| explode | `true` | `*` modifier suffix | +| field | value | equivalent | +| ------------- | ---------- | ------------------- | +| style | `"simple"` | _n/a_ | +| style | `"matrix"` | `;` prefix operator | +| style | `"label"` | `.` prefix operator | +| style | `"form"` | `?` prefix operator | +| allowReserved | `false` | _n/a_ | +| allowReserved | `true` | `+` prefix operator | +| explode | `false` | _n/a_ | +| explode | `true` | `*` modifier suffix | Multiple `style: "form"` parameters are equivalent to a single RFC6570 [variable list](https://www.rfc-editor.org/rfc/rfc6570#section-2.2) using the `?` prefix operator: ```yaml parameters: -- name: foo - in: query - schema: - type: object - explode: true -- name: bar - in: query - schema: - type: string + - name: foo + in: query + schema: + type: object + explode: true + - name: bar + in: query + schema: + type: string ``` This example is equivalent to RFC6570's `{?foo*,bar}`, and **NOT** `{?foo*}{&bar}`. The latter is problematic because if `foo` is not defined, the result will be an invalid URI. @@ -4925,9 +4920,9 @@ Implementations MAY create a properly delimited URI Template with variables for This includes: -* the styles `pipeDelimited`, `spaceDelimited`, and `deepObject`, which have no equivalents at all -* the combination of the style `form` with `allowReserved: true`, which is not allowed because only one prefix operator can be used at a time -* any parameter name that is not a legal RFC6570 variable name +- the styles `pipeDelimited`, `spaceDelimited`, and `deepObject`, which have no equivalents at all +- the combination of the style `form` with `allowReserved: true`, which is not allowed because only one prefix operator can be used at a time +- any parameter name that is not a legal RFC6570 variable name The Parameter Object's `name` field has a much more permissive syntax than RFC6570 [variable name syntax](https://www.rfc-editor.org/rfc/rfc6570#section-2.3). A parameter name that includes characters outside of the allowed RFC6570 variable character set MUST be percent-encoded before it can be used in a URI Template. @@ -4942,9 +4937,9 @@ formulas: b: x/y c: x^y words: -- math -- is -- fun + - math + - is + - fun ``` #### RFC6570-Equivalent Expansion @@ -4953,19 +4948,19 @@ This array of Parameter Objects uses regular `style: "form"` expansion, fully su ```yaml parameters: -- name: formulas - in: query - schema: - type: object - additionalProperties: - type: string - explode: true -- name: words - in: query - schema: - type: array - items: - type: string + - name: formulas + in: query + schema: + type: object + additionalProperties: + type: string + explode: true + - name: words + in: query + schema: + type: array + items: + type: string ``` This translates to the following URI Template: @@ -4987,22 +4982,22 @@ To do that, we'll add `allowReserved: true` to `formulas`, and change to `style: ```yaml parameters: -- name: formulas - in: query - schema: - type: object - additionalProperties: - type: string - explode: true - allowReserved: true -- name: words - in: query - style: spaceDelimited - explode: false - schema: - type: array - items: - type: string + - name: formulas + in: query + schema: + type: object + additionalProperties: + type: string + explode: true + allowReserved: true + - name: words + in: query + style: spaceDelimited + explode: false + schema: + type: array + items: + type: string ``` We can't combine the `?` and `+` RFC6570 [prefixes](https://datatracker.ietf.org/doc/html/rfc6570#section-2.4.1), and there's no way with RFC6570 to replace the `,` separator with a space character. @@ -5022,7 +5017,7 @@ We'll also need to pre-process the values for `formulas` because while `/` and m Setting `allowReserved: true` does _not_ make reserved characters that are not allowed in URIs allowed, it just allows them to be _passed through expansion unchanged_, for example because some other specification has defined a particular meaning for them. Therefore, users still need to percent-encode any reserved characters that are _not_ being passed through due to a special meaning because reserved expansion does not know which reserved characters are being used, and which should still be percent-encoded. -However, reserved expansion, unlike regular expansion, _will_ leave the pre-percent-encoded triples unchanged. +However, reserved expansion, unlike regular expansion, _will_ leave the pre-percent-encoded triples unchanged. See also [Appendix E](#appendix-e-percent-encoding-and-form-media-types) for further guidance on percent-encoding and form media types, including guidance on handling the delimiter characters for `spaceDelimited`, `pipeDelimited`, and `deepObject` in parameter names and values. So here is our data structure that arranges the names and values to suit the template above, where values for `formulas` have `[]#&=+` pre-percent encoded (although only `+` appears in this example): @@ -5051,8 +5046,8 @@ Care must be taken when manually constructing templates to handle the values tha ```yaml formulas: {} words: -- hello -- world + - hello + - world ``` Using this data with our original RFC6570-friendly URI Template, `{?formulas*,words}`, produces the following: @@ -5088,10 +5083,10 @@ In this example, the heart emoji is not legal in URI Template names (or URIs): ```yaml parameters: -- name: ❤️ - in: query - schema: - type: string + - name: ❤️ + in: query + schema: + type: string ``` We can't just pass `❤️: "love!"` to an RFC6570 implementation. @@ -5137,10 +5132,10 @@ _**NOTE:** In this section, the `application/x-www-form-urlencoded` and `multipa Percent-encoding is used in URIs and media types that derive their syntax from URIs. The fundamental rules of percent-encoding are: -* The set of characters that MUST be encoded varies depending on which version of which specification you use, and (for URIs) in which part of the URI the character appears. -* The way an unencoded `+` character is decoded depends on whether you are using `application/x-www-form-urlencoded` rules or more general URI rules; this is the only time where choice of decoding algorithm can change the outcome. -* Encoding more characters than necessary is always safe in terms of the decoding process, but may produce non-normalized URIs. -* In practice, some systems tolerate or even expect unencoded characters that some or all percent-encoding specifications require to be encoded; this can cause interoperability issues with more strictly compliant implementations. +- The set of characters that MUST be encoded varies depending on which version of which specification you use, and (for URIs) in which part of the URI the character appears. +- The way an unencoded `+` character is decoded depends on whether you are using `application/x-www-form-urlencoded` rules or more general URI rules; this is the only time where choice of decoding algorithm can change the outcome. +- Encoding more characters than necessary is always safe in terms of the decoding process, but may produce non-normalized URIs. +- In practice, some systems tolerate or even expect unencoded characters that some or all percent-encoding specifications require to be encoded; this can cause interoperability issues with more strictly compliant implementations. The rest of this appendix provides more detailed guidance based on the above rules. @@ -5148,9 +5143,9 @@ The rest of this appendix provides more detailed guidance based on the above rul This process is concerned with three classes of characters, the names of which vary among specifications but are defined as follows for the purposes of this section: -* _unreserved_ characters do not need to be percent-encoded; while it is safe to percent-encode them, doing so produces a URI that is [not normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.2) -* _reserved_ characters either have special behavior in the URI syntax (such as delimiting components) or are reserved for other specifications that need to define special behavior (e.g. `form-urlencoded` defines special behavior for `=`, `&`, and `+`) -* _unsafe_ characters are known to cause problems when parsing URIs in certain environments +- _unreserved_ characters do not need to be percent-encoded; while it is safe to percent-encode them, doing so produces a URI that is [not normalized](https://datatracker.ietf.org/doc/html/rfc3986#section-6.2.2.2) +- _reserved_ characters either have special behavior in the URI syntax (such as delimiting components) or are reserved for other specifications that need to define special behavior (e.g. `form-urlencoded` defines special behavior for `=`, `&`, and `+`) +- _unsafe_ characters are known to cause problems when parsing URIs in certain environments Unless otherwise specified, this section uses RFC3986's definition of [reserved](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2) and [unreserved](https://datatracker.ietf.org/doc/html/rfc3986#section-2.3), and defines the unsafe set as all characters not included in either of those sets. @@ -5180,10 +5175,10 @@ Unfortunately, these specifications each define slightly different percent-encod This specification normatively cites the following relevant standards: -| Specification | Date | OAS Usage | Percent-Encoding | Notes | -| ---- | ---- | ---- | ---- | ---- | -| [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) | 01/2005 | URI/URL syntax, including non-`form-urlencoded` content-based serialization | [[RFC3986]] | obsoletes [[?RFC1738]], [[?RFC2396]] | -| [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) | 03/2012 | style-based serialization | [[RFC3986]] | does not use `+` for query strings | +| Specification | Date | OAS Usage | Percent-Encoding | Notes | +| -------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------ | +| [RFC3986](https://www.rfc-editor.org/rfc/rfc3986) | 01/2005 | URI/URL syntax, including non-`form-urlencoded` content-based serialization | [[RFC3986]] | obsoletes [[?RFC1738]], [[?RFC2396]] | +| [RFC6570](https://www.rfc-editor.org/rfc/rfc6570) | 03/2012 | style-based serialization | [[RFC3986]] | does not use `+` for query strings | | [WHATWG-URL Section 5](https://url.spec.whatwg.org/#application/x-www-form-urlencoded) | "living" standard | content-based `form/url-encoded` serialization, including HTTP message contents | [WHATWG-URL Section 1.3](https://url.spec.whatwg.org/#application-x-www-form-urlencoded-percent-encode-set) | obsoletes [[?RFC1866]], [[?HTML401]] | Style-based serialization with percent-encoding is used in the [Parameter Object](#parameter-object) when `schema` is present, and in the [Encoding Object](#encoding-object) when at least one of `style`, `explode`, or `allowReserved` is present. @@ -5401,7 +5396,6 @@ While this sort of internal resolution can be performed in practice without choo Let's re-consider the first example in this appendix, but with relative URI references for `$self` and `$id`, and retrieval URIs that support that relative usage: - Assume that the following is retrieved from `https://staging.example.com/api/openapi`: ```yaml @@ -5445,20 +5439,20 @@ components: In this example, all of the `$self` and `$id` values are relative URI references consisting of an absolute path. This allows the retrieval URI to set the host (and scheme), in this case `https://staging.example.com`, resulting in the first document's `$self` being `https://staging.example.com/openapi`, and the second document's `$self` being `https://staging.example.com/api/shared/foo`, with `$id` values of `https://staging.example.com/api/schemas/foo` and `https://staging.example.com/api/schemas/bar`. -Relative `$self` and `$id` values of this sort allow the same set of documents to work when deployed to other hosts, e.g. `https://example.com` (production) or `https://localhost:8080` (local development). +Relative `$self` and `$id` values of this sort allow the same set of documents to work when deployed to other hosts, e.g. `https://example.com` (production) or `https://localhost:8080` (local development). ## Appendix G: Parsing and Resolution Guidance Implementations MAY support complete-document parsing in any of the following ways: -* Detecting OpenAPI or JSON Schema documents using media types -* Detecting OpenAPI documents through the root `openapi` field -* Detecting JSON Schema documents through detecting keywords or otherwise successfully parsing the document in accordance with the JSON Schema specification +- Detecting OpenAPI or JSON Schema documents using media types +- Detecting OpenAPI documents through the root `openapi` field +- Detecting JSON Schema documents through detecting keywords or otherwise successfully parsing the document in accordance with the JSON Schema specification Additional mechanisms can be used to support documents with Objects other than an OpenAPI Object or a Schema Object at the root, but note that the resulting behavior is implementation-defined: -* Detecting a document containing a referenceable Object at its root based on the expected type of the reference -* Allowing users to configure the type of documents that might be loaded due to a reference to a non-root Object +- Detecting a document containing a referenceable Object at its root based on the expected type of the reference +- Allowing users to configure the type of documents that might be loaded due to a reference to a non-root Object ### Warnings Regarding Fragmentary Parsing @@ -5473,9 +5467,9 @@ This specification does not explicitly enumerate the conditions under which such JSON or YAML objects within an OAD are interpreted as specific Objects (such as [Operation Objects](#operation-object), [Response Objects](#response-object), [Reference Objects](#reference-object), etc.) based on their context. Depending on how references are arranged, a given JSON or YAML object can be interpreted in multiple different contexts: -* As the root object of the [entry document](#openapi-description-structure), which is always interpreted as an OpenAPI Object -* As the Object type implied by its parent Object's field within the document -* As a reference target, with the Object type matching the reference source's context +- As the root object of the [entry document](#openapi-description-structure), which is always interpreted as an OpenAPI Object +- As the Object type implied by its parent Object's field within the document +- As a reference target, with the Object type matching the reference source's context If the same JSON/YAML object is parsed multiple times and the respective contexts require it to be parsed as _different_ Object types, the resulting behavior is _implementation defined_, and MAY be treated as an error if detected. An example would be referencing an empty Schema Object under `#/components/schemas` where a Path Item Object is expected, as an empty object is valid for both types. For maximum interoperability, it is RECOMMENDED that OpenAPI Description authors avoid such scenarios. @@ -5483,12 +5477,12 @@ If the same JSON/YAML object is parsed multiple times and the respective context The following Objects and Fields involve the use of implicit connections: -| Source | Target | Alternative | -| ---- | ---- | ---- | -| [Security Requirement Object](#security-requirement-object) `{name}` | [Security Scheme Object](#security-scheme-object) name under the [Components Object](#components-object) | _n/a_ | -| [Discriminator Object](#discriminator-object) `mapping` _(implicit, or explicit name syntax)_ | [Schema Object](#schema-object) name under the Components Object | `mapping` _(explicit URI syntax)_ | -| [Operation Object](#operation-object) `tags` | [Tag Object](#tag-object) `name` (in the [OpenAPI Object](#openapi-object)'s `tags` array) | _n/a_ | -| [Link Object](#link-object) `operationId` | [Operation Object](#operation-object) `operationId` | `operationRef` | +| Source | Target | Alternative | +| --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------- | +| [Security Requirement Object](#security-requirement-object) `{name}` | [Security Scheme Object](#security-scheme-object) name under the [Components Object](#components-object) | _n/a_ | +| [Discriminator Object](#discriminator-object) `mapping` _(implicit, or explicit name syntax)_ | [Schema Object](#schema-object) name under the Components Object | `mapping` _(explicit URI syntax)_ | +| [Operation Object](#operation-object) `tags` | [Tag Object](#tag-object) `name` (in the [OpenAPI Object](#openapi-object)'s `tags` array) | _n/a_ | +| [Link Object](#link-object) `operationId` | [Operation Object](#operation-object) `operationId` | `operationRef` | An additional implicit connection involves appending the templated URL paths of the [Paths Object](#paths-object) to the appropriate [Server Object](#server-object)'s `url` field. This connection is unambiguous because only the entry document's Paths Object contributes URLs to the described API. @@ -5551,7 +5545,7 @@ components: bearerFormat: JWT paths: /foo: - $ref: 'other#/components/pathItems/Foo' + $ref: "other#/components/pathItems/Foo" ``` This entry document references another document, `other`, without using a file extension. This gives the client the flexibility to choose an acceptable format on a resource-by-resource basis, assuming both representations are available: diff --git a/3.2/components.ts b/3.2/components.ts index 08f8892..1dab559 100644 --- a/3.2/components.ts +++ b/3.2/components.ts @@ -57,122 +57,122 @@ import type { Server } from "./servers"; * ``` */ export interface Components extends Extension { - /** - * An object to hold reusable Schema Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - schemas} | - * - * @property `schemas` - Optional An object to hold reusable Schema Objects - * - * @example { "User": { type: "object", properties: { id: { type: "integer" } } } } - */ - schemas?: Record; + /** + * An object to hold reusable Schema Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - schemas} | + * + * @property `schemas` - Optional An object to hold reusable Schema Objects + * + * @example { "User": { type: "object", properties: { id: { type: "integer" } } } } + */ + schemas?: Record; - /** - * An object to hold reusable Response Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - responses} | - * - * @property `responses` - Optional An object to hold reusable Response Objects - * - * @example { "NotFound": { description: "Resource not found" } } - */ - responses?: Record; + /** + * An object to hold reusable Response Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - responses} | + * + * @property `responses` - Optional An object to hold reusable Response Objects + * + * @example { "NotFound": { description: "Resource not found" } } + */ + responses?: Record; - /** - * An object to hold reusable Parameter Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - parameters} | - * - * @property `parameters` - Optional An object to hold reusable Parameter Objects - * - * @example { "LimitParam": { name: "limit", in: "query", schema: { type: "integer" } } } - */ - parameters?: Record; + /** + * An object to hold reusable Parameter Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - parameters} | + * + * @property `parameters` - Optional An object to hold reusable Parameter Objects + * + * @example { "LimitParam": { name: "limit", in: "query", schema: { type: "integer" } } } + */ + parameters?: Record; - /** - * An object to hold reusable Example Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - examples} | - * - * @property `examples` - Optional An object to hold reusable Example Objects - * - * @example { "UserExample": { summary: "A user example", value: { id: 1, name: "John" } } } - */ - examples?: Record; + /** + * An object to hold reusable Example Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - examples} | + * + * @property `examples` - Optional An object to hold reusable Example Objects + * + * @example { "UserExample": { summary: "A user example", value: { id: 1, name: "John" } } } + */ + examples?: Record; - /** - * An object to hold reusable Request Body Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - requestBodies} | - * - * @property `requestBodies` - Optional An object to hold reusable Request Body Objects - * - * @example { "UserRequest": { description: "User data", content: { "application/json": { schema: { $ref: "#/components/schemas/User" } } } } } - */ - requestBodies?: Record; + /** + * An object to hold reusable Request Body Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - requestBodies} | + * + * @property `requestBodies` - Optional An object to hold reusable Request Body Objects + * + * @example { "UserRequest": { description: "User data", content: { "application/json": { schema: { $ref: "#/components/schemas/User" } } } } } + */ + requestBodies?: Record; - /** - * An object to hold reusable Header Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - headers} | - * - * @property `headers` - Optional An object to hold reusable Header Objects - * - * @example { "RateLimit": { description: "Rate limit header", schema: { type: "integer" } } } - */ - headers?: Record; + /** + * An object to hold reusable Header Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - headers} | + * + * @property `headers` - Optional An object to hold reusable Header Objects + * + * @example { "RateLimit": { description: "Rate limit header", schema: { type: "integer" } } } + */ + headers?: Record; - /** - * An object to hold reusable Security Scheme Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - securitySchemes} | - * - * @property `securitySchemes` - Optional An object to hold reusable Security Scheme Objects - * - * @example { "ApiKeyAuth": { type: "apiKey", in: "header", name: "X-API-Key" } } - */ - securitySchemes?: Record; + /** + * An object to hold reusable Security Scheme Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - securitySchemes} | + * + * @property `securitySchemes` - Optional An object to hold reusable Security Scheme Objects + * + * @example { "ApiKeyAuth": { type: "apiKey", in: "header", name: "X-API-Key" } } + */ + securitySchemes?: Record; - /** - * An object to hold reusable Link Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - links} | - * - * @property `links` - Optional An object to hold reusable Link Objects - * - * @example { "UserRepositories": { operationId: "getUserRepositories", parameters: { username: "$response.body#/username" } } } - */ - links?: Record; + /** + * An object to hold reusable Link Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - links} | + * + * @property `links` - Optional An object to hold reusable Link Objects + * + * @example { "UserRepositories": { operationId: "getUserRepositories", parameters: { username: "$response.body#/username" } } } + */ + links?: Record; - /** - * An object to hold reusable Callback Objects. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - callbacks} | - * - * @property `callbacks` - Optional An object to hold reusable Callback Objects - * - * @example { "MyCallback": { "{$request.body#/callbackUrl}": { post: { requestBody: { $ref: "#/components/requestBodies/SomeRequestBody" } } } } } - */ - callbacks?: Record; + /** + * An object to hold reusable Callback Objects. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object | OpenAPI 3.2.0 Components Object - callbacks} | + * + * @property `callbacks` - Optional An object to hold reusable Callback Objects + * + * @example { "MyCallback": { "{$request.body#/callbackUrl}": { post: { requestBody: { $ref: "#/components/requestBodies/SomeRequestBody" } } } } } + */ + callbacks?: Record; } /** @@ -219,58 +219,58 @@ export interface Components extends Extension { * ``` */ export interface Response extends Extension { - /** - * A short description of the response. CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object | OpenAPI 3.2.0 Response Object - description} | - * - * @property `description` - Required A short description of the response - * - * @example "A list of pets" - * @example "User created successfully" - */ - description: string; + /** + * A short description of the response. CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object | OpenAPI 3.2.0 Response Object - description} | + * + * @property `description` - Required A short description of the response + * + * @example "A list of pets" + * @example "User created successfully" + */ + description: string; - /** - * Maps a header name to its definition. Header names are case insensitive. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object | OpenAPI 3.2.0 Response Object - headers} | - * - * @property `headers` - Optional Maps a header name to its definition - * - * @example { "X-RateLimit-Limit": { description: "Rate limit", schema: { type: "integer" } } } - */ - headers?: Record; + /** + * Maps a header name to its definition. Header names are case insensitive. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object | OpenAPI 3.2.0 Response Object - headers} | + * + * @property `headers` - Optional Maps a header name to its definition + * + * @example { "X-RateLimit-Limit": { description: "Rate limit", schema: { type: "integer" } } } + */ + headers?: Record; - /** - * A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object | OpenAPI 3.2.0 Response Object - content} | - * - * @property `content` - Optional A map containing descriptions of potential response payloads - * - * @example { "application/json": { schema: { type: "array", items: { $ref: "#/components/schemas/Pet" } } } } - */ - content?: Record; + /** + * A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object | OpenAPI 3.2.0 Response Object - content} | + * + * @property `content` - Optional A map containing descriptions of potential response payloads + * + * @example { "application/json": { schema: { type: "array", items: { $ref: "#/components/schemas/Pet" } } } } + */ + content?: Record; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object | OpenAPI 3.2.0 Response Object - links} | - * - * @property `links` - Optional A map of operations links that can be followed from the response - * - * @example { "UserRepositories": { operationId: "getUserRepositories", parameters: { username: "$response.body#/username" } } } - */ - links?: Record; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object | OpenAPI 3.2.0 Response Object - links} | + * + * @property `links` - Optional A map of operations links that can be followed from the response + * + * @example { "UserRepositories": { operationId: "getUserRepositories", parameters: { username: "$response.body#/username" } } } + */ + links?: Record; } /** @@ -320,164 +320,164 @@ export interface Response extends Extension { * ``` */ export interface Header extends Extension { - /** - * A brief description of the header. This could contain examples of use. - * CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - description} | - * - * @property `description` - Optional A brief description of the header - * - * @example "Rate limit header" - * @example "Authentication token" - */ - description?: string; + /** + * A brief description of the header. This could contain examples of use. + * CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - description} | + * + * @property `description` - Optional A brief description of the header + * + * @example "Rate limit header" + * @example "Authentication token" + */ + description?: string; - /** - * Determines whether this header is mandatory. Default value is false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - required} | - * - * @property `required` - Optional Determines whether this header is mandatory - * - * @example true - * @example false - */ - required?: boolean; + /** + * Determines whether this header is mandatory. Default value is false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - required} | + * + * @property `required` - Optional Determines whether this header is mandatory + * + * @example true + * @example false + */ + required?: boolean; - /** - * Specifies that a header is deprecated and SHOULD be transitioned out of usage. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - deprecated} | - * - * @property `deprecated` - Optional Specifies that a header is deprecated and SHOULD be transitioned out of usage - * - * @example true - * @example false - */ - deprecated?: boolean; + /** + * Specifies that a header is deprecated and SHOULD be transitioned out of usage. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - deprecated} | + * + * @property `deprecated` - Optional Specifies that a header is deprecated and SHOULD be transitioned out of usage + * + * @example true + * @example false + */ + deprecated?: boolean; - /** - * Sets the ability to pass empty-valued headers. Default value is false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - allowEmptyValue} | - * - * @property `allowEmptyValue` - Optional Sets the ability to pass empty-valued headers - * - * @example true - * @example false - */ - allowEmptyValue?: boolean; + /** + * Sets the ability to pass empty-valued headers. Default value is false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - allowEmptyValue} | + * + * @property `allowEmptyValue` - Optional Sets the ability to pass empty-valued headers + * + * @example true + * @example false + */ + allowEmptyValue?: boolean; - /** - * Describes how the header value will be serialized. Default value is "simple". - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - style} | - * - * @property `style` - Optional Describes how the header value will be serialized - * - * @example "simple" - */ - style?: "simple"; + /** + * Describes how the header value will be serialized. Default value is "simple". + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - style} | + * + * @property `style` - Optional Describes how the header value will be serialized + * + * @example "simple" + */ + style?: "simple"; - /** - * When this is true, header values of type array or object generate separate headers - * for each value of the array or key-value pair of the map. For other types of headers - * this property has no effect. Default value is false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - explode} | - * - * @property `explode` - Optional When this is true, header values of type array or object generate separate headers - * - * @example true - * @example false - */ - explode?: boolean; + /** + * When this is true, header values of type array or object generate separate headers + * for each value of the array or key-value pair of the map. For other types of headers + * this property has no effect. Default value is false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - explode} | + * + * @property `explode` - Optional When this is true, header values of type array or object generate separate headers + * + * @example true + * @example false + */ + explode?: boolean; - /** - * Determines whether the header value SHOULD allow reserved characters, as defined by - * RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - allowReserved} | - * - * @property `allowReserved` - Optional Determines whether the header value SHOULD allow reserved characters - * - * @example true - * @example false - */ - allowReserved?: boolean; + /** + * Determines whether the header value SHOULD allow reserved characters, as defined by + * RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - allowReserved} | + * + * @property `allowReserved` - Optional Determines whether the header value SHOULD allow reserved characters + * + * @example true + * @example false + */ + allowReserved?: boolean; - /** - * The schema defining the type used for the header. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - schema} | - * - * @property `schema` - Optional The schema defining the type used for the header - * - * @example { type: "integer" } - * @example { type: "string", format: "date-time" } - */ - schema?: Schema; + /** + * The schema defining the type used for the header. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - schema} | + * + * @property `schema` - Optional The schema defining the type used for the header + * + * @example { type: "integer" } + * @example { type: "string", format: "date-time" } + */ + schema?: Schema; - /** - * Example of the header. The example SHOULD match the specified schema and encoding - * properties if present. The example object is mutually exclusive of the examples object. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - example} | - * - * @property `example` - Optional Example of the header - * - * @example "example-value" - * @example 42 - */ - example?: unknown; + /** + * Example of the header. The example SHOULD match the specified schema and encoding + * properties if present. The example object is mutually exclusive of the examples object. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - example} | + * + * @property `example` - Optional Example of the header + * + * @example "example-value" + * @example 42 + */ + example?: unknown; - /** - * Examples of the header. Each example SHOULD contain a value in the correct format - * as specified in the header encoding. The examples object is mutually exclusive of - * the example object. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - examples} | - * - * @property `examples` - Optional Examples of the header - * - * @example { "header1": { summary: "A header example", value: "header123" } } - */ - examples?: Record; + /** + * Examples of the header. Each example SHOULD contain a value in the correct format + * as specified in the header encoding. The examples object is mutually exclusive of + * the example object. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - examples} | + * + * @property `examples` - Optional Examples of the header + * + * @example { "header1": { summary: "A header example", value: "header123" } } + */ + examples?: Record; - /** - * A map containing the representations for the header. The key is the media type - * and the value describes it. The map MUST only contain one entry. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - content} | - * - * @property `content` - Optional A map containing the representations for the header - * - * @example { "application/json": { schema: { type: "object" } } } - */ - content?: Record; + /** + * A map containing the representations for the header. The key is the media type + * and the value describes it. The map MUST only contain one entry. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object | OpenAPI 3.2.0 Header Object - content} | + * + * @property `content` - Optional A map containing the representations for the header + * + * @example { "application/json": { schema: { type: "object" } } } + */ + content?: Record; } /** @@ -518,64 +518,64 @@ export interface Header extends Extension { * ``` */ export interface Example extends Extension { - /** - * Short description for the example. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object | OpenAPI 3.2.0 Example Object - summary} | - * - * @property `summary` - Optional Short description for the example - * - * @example "A user example" - * @example "Error response" - */ - summary?: string; + /** + * Short description for the example. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object | OpenAPI 3.2.0 Example Object - summary} | + * + * @property `summary` - Optional Short description for the example + * + * @example "A user example" + * @example "Error response" + */ + summary?: string; - /** - * Long description for the example. CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object | OpenAPI 3.2.0 Example Object - description} | - * - * @property `description` - Optional Long description for the example - * - * @example "An example of a user object with all fields populated" - * @example "An example of an error response when the user is not found" - */ - description?: string; + /** + * Long description for the example. CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object | OpenAPI 3.2.0 Example Object - description} | + * + * @property `description` - Optional Long description for the example + * + * @example "An example of a user object with all fields populated" + * @example "An example of an error response when the user is not found" + */ + description?: string; - /** - * Embedded literal example. The value field and externalValue field are mutually exclusive. - * To represent examples of media types that cannot naturally represented in JSON or YAML, - * use a string value to contain the example, escaping where necessary. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object | OpenAPI 3.2.0 Example Object - value} | - * - * @property `value` - Optional Embedded literal example - * - * @example { "id": 1, "name": "John Doe" } - * @example "example-value" - * @example 42 - */ - value?: unknown; + /** + * Embedded literal example. The value field and externalValue field are mutually exclusive. + * To represent examples of media types that cannot naturally represented in JSON or YAML, + * use a string value to contain the example, escaping where necessary. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object | OpenAPI 3.2.0 Example Object - value} | + * + * @property `value` - Optional Embedded literal example + * + * @example { "id": 1, "name": "John Doe" } + * @example "example-value" + * @example 42 + */ + value?: unknown; - /** - * A URI that points to a 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object | OpenAPI 3.2.0 Example Object - externalValue} | - * - * @property `externalValue` - Optional A URI that points to a literal example - * - * @example "https://example.org/examples/user-example.json" - * @example "https://example.org/examples/error-example.xml" - */ - externalValue?: string; + /** + * A URI that points to a 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object | OpenAPI 3.2.0 Example Object - externalValue} | + * + * @property `externalValue` - Optional A URI that points to a literal example + * + * @example "https://example.org/examples/user-example.json" + * @example "https://example.org/examples/error-example.xml" + */ + externalValue?: string; } /** @@ -618,47 +618,47 @@ export interface Example extends Extension { * ``` */ export interface RequestBody extends Extension { - /** - * A brief description of the request body. This could contain examples of use. - * CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object | OpenAPI 3.2.0 Request Body Object - description} | - * - * @property `description` - Optional A brief description of the request body - * - * @example "User data" - * @example "Pet information to add to the store" - */ - description?: string; + /** + * A brief description of the request body. This could contain examples of use. + * CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object | OpenAPI 3.2.0 Request Body Object - description} | + * + * @property `description` - Optional A brief description of the request body + * + * @example "User data" + * @example "Pet information to add to the store" + */ + description?: string; - /** - * The content of the request body. The key is a media type or media type range and the value describes it. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object | OpenAPI 3.2.0 Request Body Object - content} | - * - * @property `content` - Required The content of the request body - * - * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } - */ - content: Record; + /** + * The content of the request body. The key is a media type or media type range and the value describes it. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object | OpenAPI 3.2.0 Request Body Object - content} | + * + * @property `content` - Required The content of the request body + * + * @example { "application/json": { schema: { $ref: "#/components/schemas/User" } } } + */ + content: Record; - /** - * Determines if the request body is required in the request. Defaults to false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object | OpenAPI 3.2.0 Request Body Object - required} | - * - * @property `required` - Optional Determines if the request body is required in the request - * - * @example true - * @example false - */ - required?: boolean; + /** + * Determines if the request body is required in the request. Defaults to false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object | OpenAPI 3.2.0 Request Body Object - required} | + * + * @property `required` - Optional Determines if the request body is required in the request + * + * @example true + * @example false + */ + required?: boolean; } /** @@ -705,120 +705,120 @@ export interface RequestBody extends Extension { * ``` */ export interface SecurityScheme extends Extension { - /** - * The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect". - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - type} | - * - * @property `type` - Required The type of the security scheme - * - * @example "apiKey" - * @example "http" - * @example "oauth2" - * @example "openIdConnect" - */ - type: "apiKey" | "http" | "oauth2" | "openIdConnect"; + /** + * The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect". + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - type} | + * + * @property `type` - Required The type of the security scheme + * + * @example "apiKey" + * @example "http" + * @example "oauth2" + * @example "openIdConnect" + */ + type: "apiKey" | "http" | "oauth2" | "openIdConnect"; - /** - * A short description for security scheme. CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - description} | - * - * @property `description` - Optional A short description for security scheme - * - * @example "API key authentication" - * @example "OAuth2 authentication" - */ - description?: string; + /** + * A short description for security scheme. CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - description} | + * + * @property `description` - Optional A short description for security scheme + * + * @example "API key authentication" + * @example "OAuth2 authentication" + */ + description?: string; - /** - * The name of the header, query or cookie parameter to be used. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - name} | - * - * @property `name` - Optional The name of the header, query or cookie parameter to be used - * - * @example "X-API-Key" - * @example "Authorization" - */ - name?: string; + /** + * The name of the header, query or cookie parameter to be used. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - name} | + * + * @property `name` - Optional The name of the header, query or cookie parameter to be used + * + * @example "X-API-Key" + * @example "Authorization" + */ + name?: string; - /** - * The location of the API key. Valid values are "query", "header" or "cookie". - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - in} | - * - * @property `in` - Optional The location of the API key - * - * @example "query" - * @example "header" - * @example "cookie" - */ - in?: "query" | "header" | "cookie"; + /** + * The location of the API key. Valid values are "query", "header" or "cookie". + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - in} | + * + * @property `in` - Optional The location of the API key + * + * @example "query" + * @example "header" + * @example "cookie" + */ + in?: "query" | "header" | "cookie"; - /** - * The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - scheme} | - * - * @property `scheme` - Optional The name of the HTTP Authorization scheme to be used in the Authorization header - * - * @example "basic" - * @example "bearer" - * @example "digest" - */ - scheme?: string; + /** + * The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - scheme} | + * + * @property `scheme` - Optional The name of the HTTP Authorization scheme to be used in the Authorization header + * + * @example "basic" + * @example "bearer" + * @example "digest" + */ + scheme?: string; - /** - * A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily - * generated by an authorization server, so this field is a hint only. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - bearerFormat} | - * - * @property `bearerFormat` - Optional A hint to the client to identify how the bearer token is formatted - * - * @example "JWT" - * @example "OAuth2" - */ - bearerFormat?: string; + /** + * A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily + * generated by an authorization server, so this field is a hint only. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - bearerFormat} | + * + * @property `bearerFormat` - Optional A hint to the client to identify how the bearer token is formatted + * + * @example "JWT" + * @example "OAuth2" + */ + bearerFormat?: string; - /** - * An object containing configuration information for the flow types supported. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - flows} | - * - * @property `flows` - Optional An object containing configuration information for the flow types supported - * - * @example { "implicit": { authorizationUrl: "https://example.com/oauth/authorize", scopes: { "read": "Read access" } } } - */ - flows?: OAuthFlows; + /** + * An object containing configuration information for the flow types supported. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - flows} | + * + * @property `flows` - Optional An object containing configuration information for the flow types supported + * + * @example { "implicit": { authorizationUrl: "https://example.com/oauth/authorize", scopes: { "read": "Read access" } } } + */ + flows?: OAuthFlows; - /** - * OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl} | - * - * @property `openIdConnectUrl` - Optional OpenId Connect URL to discover OAuth2 configuration values - * - * @example "https://example.com/.well-known/openid_configuration" - */ - openIdConnectUrl?: string; + /** + * OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object | OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl} | + * + * @property `openIdConnectUrl` - Optional OpenId Connect URL to discover OAuth2 configuration values + * + * @example "https://example.com/.well-known/openid_configuration" + */ + openIdConnectUrl?: string; } /** @@ -864,88 +864,88 @@ export interface SecurityScheme extends Extension { * ``` */ export interface Link extends Extension { - /** - * A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - operationRef} | - * - * @property `operationRef` - Optional A relative or absolute reference to an OAS operation - * - * @example "#/paths/~12.0~1repositories~1{username}/get" - * @example "https://example.com/openapi.json#/paths/~12.0~1repositories~1{username}/get" - */ - operationRef?: string; + /** + * A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - operationRef} | + * + * @property `operationRef` - Optional A relative or absolute reference to an OAS operation + * + * @example "#/paths/~12.0~1repositories~1{username}/get" + * @example "https://example.com/openapi.json#/paths/~12.0~1repositories~1{username}/get" + */ + operationRef?: string; - /** - * The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - operationId} | - * - * @property `operationId` - Optional The name of an existing, resolvable OAS operation - * - * @example "getUserRepositories" - * @example "getUserById" - */ - operationId?: string; + /** + * The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - operationId} | + * + * @property `operationId` - Optional The name of an existing, resolvable OAS operation + * + * @example "getUserRepositories" + * @example "getUserById" + */ + operationId?: string; - /** - * A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - parameters} | - * - * @property `parameters` - Optional A map representing parameters to pass to an operation - * - * @example { "username": "$response.body#/username" } - * @example { "id": "$response.body#/id" } - */ - parameters?: Record; + /** + * A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - parameters} | + * + * @property `parameters` - Optional A map representing parameters to pass to an operation + * + * @example { "username": "$response.body#/username" } + * @example { "id": "$response.body#/id" } + */ + parameters?: Record; - /** - * A literal value or expression to be evaluated and passed to the linked operation as a request body. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - requestBody} | - * - * @property `requestBody` - Optional A literal value or expression to be evaluated and passed to the linked operation - * - * @example "$request.body#/user" - * @example { "name": "John Doe" } - */ - requestBody?: RequestBody | Reference; + /** + * A literal value or expression to be evaluated and passed to the linked operation as a request body. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - requestBody} | + * + * @property `requestBody` - Optional A literal value or expression to be evaluated and passed to the linked operation + * + * @example "$request.body#/user" + * @example { "name": "John Doe" } + */ + requestBody?: RequestBody | Reference; - /** - * A description of the link. CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - description} | - * - * @property `description` - Optional A description of the link - * - * @example "Link to user repositories" - * @example "Link to user profile" - */ - description?: string; + /** + * A description of the link. CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - description} | + * + * @property `description` - Optional A description of the link + * + * @example "Link to user repositories" + * @example "Link to user profile" + */ + description?: string; - /** - * A server object to be used by the target operation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - server} | - * - * @property `server` - Optional A server object to be used by the target operation - * - * @example { "url": "https://api.example.com/v2" } - */ - server?: Server; + /** + * A server object to be used by the target operation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object | OpenAPI 3.2.0 Link Object - server} | + * + * @property `server` - Optional A server object to be used by the target operation + * + * @example { "url": "https://api.example.com/v2" } + */ + server?: Server; } /** @@ -988,7 +988,7 @@ export interface Link extends Extension { * ``` */ export interface Callback { - [expression: string]: PathItem | Reference | unknown; + [expression: string]: PathItem | Reference | unknown; } /** @@ -1037,87 +1037,87 @@ export interface Callback { * ``` */ export interface Encoding extends Extension { - /** - * The Content-Type for encoding a specific property. - * Default value depends on the property type: for string with format being binary – application/octet-stream; - * for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - contentType} | - * - * @property `contentType` - Optional The Content-Type for encoding a specific property - * - * @example "text/plain" - * @example "application/json" - * @example "image/png" - */ - contentType?: string; + /** + * The Content-Type for encoding a specific property. + * Default value depends on the property type: for string with format being binary – application/octet-stream; + * for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - contentType} | + * + * @property `contentType` - Optional The Content-Type for encoding a specific property + * + * @example "text/plain" + * @example "application/json" + * @example "image/png" + */ + contentType?: string; - /** - * A map allowing additional information to be provided as headers. - * For example, Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. - * This property SHALL be ignored if the request body media is not a multipart. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - headers} | - * - * @property `headers` - Optional A map allowing additional information to be provided as headers - * - * @example { "Content-Disposition": { schema: { type: "string" } } } - */ - headers?: Record; + /** + * A map allowing additional information to be provided as headers. + * For example, Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. + * This property SHALL be ignored if the request body media is not a multipart. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - headers} | + * + * @property `headers` - Optional A map allowing additional information to be provided as headers + * + * @example { "Content-Disposition": { schema: { type: "string" } } } + */ + headers?: Record; - /** - * Describes how a specific property value will be serialized depending on its type. - * See Parameter Object for details on the style property. The behavior follows the same values as query parameters. - * Default value depends on the property type: for string with format being binary – binary; for other primitive types – form. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - style} | - * - * @property `style` - Optional Describes how a specific property value will be serialized - * - * @example "form" - * @example "spaceDelimited" - * @example "pipeDelimited" - * @example "deepObject" - */ - style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject"; + /** + * Describes how a specific property value will be serialized depending on its type. + * See Parameter Object for details on the style property. The behavior follows the same values as query parameters. + * Default value depends on the property type: for string with format being binary – binary; for other primitive types – form. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - style} | + * + * @property `style` - Optional Describes how a specific property value will be serialized + * + * @example "form" + * @example "spaceDelimited" + * @example "pipeDelimited" + * @example "deepObject" + */ + style?: "form" | "spaceDelimited" | "pipeDelimited" | "deepObject"; - /** - * When this is true, property 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 properties - * this property has no effect. When style is form, the default value is true. - * For all other styles, the default value is false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - explode} | - * - * @property `explode` - Optional When this is true, property values of type array or object generate separate parameters - * - * @example true - * @example false - */ - explode?: boolean; + /** + * When this is true, property 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 properties + * this property has no effect. When style is form, the default value is true. + * For all other styles, the default value is false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - explode} | + * + * @property `explode` - Optional When this is true, property values of type array or object generate separate parameters + * + * @example true + * @example false + */ + explode?: boolean; - /** - * Determines whether the parameter value SHOULD allow reserved characters, as defined by - * RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - allowReserved} | - * - * @property `allowReserved` - Optional Determines whether the parameter value SHOULD allow reserved characters - * - * @example true - * @example false - */ - allowReserved?: boolean; + /** + * Determines whether the parameter value SHOULD allow reserved characters, as defined by + * RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object | OpenAPI 3.2.0 Encoding Object - allowReserved} | + * + * @property `allowReserved` - Optional Determines whether the parameter value SHOULD allow reserved characters + * + * @example true + * @example false + */ + allowReserved?: boolean; } /** @@ -1162,62 +1162,62 @@ export interface Encoding extends Extension { * ``` */ export interface MediaType extends Extension { - /** - * The schema defining the content of the request, response, or parameter. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object | OpenAPI 3.2.0 Media Type Object - schema} | - * - * @property `schema` - Optional The schema defining the content of the request, response, or parameter - * - * @example { type: "object", properties: { id: { type: "integer" } } } - * @example { $ref: "#/components/schemas/User" } - */ - schema?: Schema; + /** + * The schema defining the content of the request, response, or parameter. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object | OpenAPI 3.2.0 Media Type Object - schema} | + * + * @property `schema` - Optional The schema defining the content of the request, response, or parameter + * + * @example { type: "object", properties: { id: { type: "integer" } } } + * @example { $ref: "#/components/schemas/User" } + */ + schema?: Schema; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object | OpenAPI 3.2.0 Media Type Object - example} | - * - * @property `example` - Optional Example of the media type - * - * @example { "id": 1, "name": "John Doe" } - * @example "example-value" - */ - example?: unknown; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object | OpenAPI 3.2.0 Media Type Object - example} | + * + * @property `example` - Optional Example of the media type + * + * @example { "id": 1, "name": "John Doe" } + * @example "example-value" + */ + example?: unknown; - /** - * Examples of the media type. Each example SHOULD contain a value in the correct format - * as specified in the media type encoding. The examples object is mutually exclusive of - * the example object. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object | OpenAPI 3.2.0 Media Type Object - examples} | - * - * @property `examples` - Optional Examples of the media type - * - * @example { "user1": { summary: "A user example", value: { id: 1, name: "John" } } } - */ - examples?: Record; + /** + * Examples of the media type. Each example SHOULD contain a value in the correct format + * as specified in the media type encoding. The examples object is mutually exclusive of + * the example object. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object | OpenAPI 3.2.0 Media Type Object - examples} | + * + * @property `examples` - Optional Examples of the media type + * + * @example { "user1": { summary: "A user example", value: { id: 1, name: "John" } } } + */ + examples?: Record; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object | OpenAPI 3.2.0 Media Type Object - encoding} | - * - * @property `encoding` - Optional A map between a property name and its encoding information - * - * @example { "name": { contentType: "text/plain" } } - */ - encoding?: Record; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object | OpenAPI 3.2.0 Media Type Object - encoding} | + * + * @property `encoding` - Optional A map between a property name and its encoding information + * + * @example { "name": { contentType: "text/plain" } } + */ + encoding?: Record; } diff --git a/3.2/data-types/array.ts b/3.2/data-types/array.ts index c27647e..f19160f 100644 --- a/3.2/data-types/array.ts +++ b/3.2/data-types/array.ts @@ -84,130 +84,130 @@ import type { XML } from "../xml"; * ``` */ export interface ArraySchema extends Extension { - /** - * The type identifier for array schemas. - * Must be "array". - */ - type: "array"; + /** + * The type identifier for array schemas. + * Must be "array". + */ + type: "array"; - /** - * The schema for array items. - * All items in the array must conform to this schema. - * - * Example: `{ type: "string" }` - */ - items?: Schema; + /** + * The schema for array items. + * All items in the array must conform to this schema. + * + * Example: `{ type: "string" }` + */ + items?: Schema; - /** - * The schema for array items at specific positions. - * Items at position i must conform to the schema at index i. - * - * Example: `[{ type: "string" }, { type: "number" }]` - */ - prefixItems?: Schema[]; + /** + * The schema for array items at specific positions. + * Items at position i must conform to the schema at index i. + * + * Example: `[{ type: "string" }, { type: "number" }]` + */ + prefixItems?: Schema[]; - /** - * The schema that the array must contain at least one item matching. - * At least one item in the array must conform to this schema. - * - * Example: `{ type: "string", enum: ["admin"] }` - */ - contains?: Schema; + /** + * The schema that the array must contain at least one item matching. + * At least one item in the array must conform to this schema. + * + * Example: `{ type: "string", enum: ["admin"] }` + */ + contains?: Schema; - /** - * The minimum number of items that must match the contains schema. - * Must be a non-negative integer. - * - * Example: `1` - */ - minContains?: number; + /** + * The minimum number of items that must match the contains schema. + * Must be a non-negative integer. + * + * Example: `1` + */ + minContains?: number; - /** - * The maximum number of items that must match the contains schema. - * Must be a non-negative integer. - * - * Example: `5` - */ - maxContains?: number; + /** + * The maximum number of items that must match the contains schema. + * Must be a non-negative integer. + * + * Example: `5` + */ + maxContains?: number; - /** - * The minimum number of items in the array. - * Must be a non-negative integer. - * - * Example: `1` - */ - minItems?: number; + /** + * The minimum number of items in the array. + * Must be a non-negative integer. + * + * Example: `1` + */ + minItems?: number; - /** - * The maximum number of items in the array. - * Must be a non-negative integer. - * - * Example: `10` - */ - maxItems?: number; + /** + * The maximum number of items in the array. + * Must be a non-negative integer. + * + * Example: `10` + */ + maxItems?: number; - /** - * Whether array items must be unique. - * If true, all items in the array must be unique. - * - * Example: `true` - */ - uniqueItems?: boolean; + /** + * Whether array items must be unique. + * If true, all items in the array must be unique. + * + * Example: `true` + */ + uniqueItems?: boolean; - /** - * An array of allowed values for the array. - * The value must be one of the values in this array. - * - * Example: `[["a", "b"], ["c", "d"]]` - */ - enum?: unknown[]; + /** + * An array of allowed values for the array. + * The value must be one of the values in this array. + * + * Example: `[["a", "b"], ["c", "d"]]` + */ + enum?: unknown[]; - /** - * A single allowed value for the array. - * The value must be exactly this value. - * - * Example: `["a", "b"]` - */ - const?: unknown; + /** + * A single allowed value for the array. + * The value must be exactly this value. + * + * Example: `["a", "b"]` + */ + const?: unknown; - /** - * An array of example values for the array. - * These are for documentation purposes only. - * - * Example: `[["a", "b"], ["c", "d"]]` - */ - examples?: unknown[]; + /** + * An array of example values for the array. + * These are for documentation purposes only. + * + * Example: `[["a", "b"], ["c", "d"]]` + */ + examples?: unknown[]; - /** - * The default value for the array. - * This value will be used if no value is provided. - * - * Example: `[]` - */ - default?: unknown[]; + /** + * The default value for the array. + * This value will be used if no value is provided. + * + * Example: `[]` + */ + default?: unknown[]; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"User Tags"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"User Tags"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"Array of user tags"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"Array of user tags"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions using the modernized - * nodeType approach in OpenAPI 3.2.0. - * - * Example: `{ nodeType: "element", name: "users" }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions using the modernized + * nodeType approach in OpenAPI 3.2.0. + * + * Example: `{ nodeType: "element", name: "users" }` + */ + xml?: XML; } diff --git a/3.2/data-types/boolean.ts b/3.2/data-types/boolean.ts index 780b11b..1718d6d 100644 --- a/3.2/data-types/boolean.ts +++ b/3.2/data-types/boolean.ts @@ -66,66 +66,66 @@ import type { XML } from "../xml"; * ``` */ export interface BooleanSchema extends Extension { - /** - * The type identifier for boolean schemas. - * Must be "boolean". - */ - type: "boolean"; + /** + * The type identifier for boolean schemas. + * Must be "boolean". + */ + type: "boolean"; - /** - * An array of allowed values for the boolean. - * The value must be one of the values in this array. - * - * Example: `[true, false]` - */ - enum?: boolean[]; + /** + * An array of allowed values for the boolean. + * The value must be one of the values in this array. + * + * Example: `[true, false]` + */ + enum?: boolean[]; - /** - * A single allowed value for the boolean. - * The value must be exactly this value. - * - * Example: `true` - */ - const?: boolean; + /** + * A single allowed value for the boolean. + * The value must be exactly this value. + * + * Example: `true` + */ + const?: boolean; - /** - * An array of example values for the boolean. - * These are for documentation purposes only. - * - * Example: `[true, false]` - */ - examples?: boolean[]; + /** + * An array of example values for the boolean. + * These are for documentation purposes only. + * + * Example: `[true, false]` + */ + examples?: boolean[]; - /** - * The default value for the boolean. - * This value will be used if no value is provided. - * - * Example: `false` - */ - default?: boolean; + /** + * The default value for the boolean. + * This value will be used if no value is provided. + * + * Example: `false` + */ + default?: boolean; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"Is Active"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"Is Active"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"Whether the user is active"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"Whether the user is active"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions using the modernized - * nodeType approach in OpenAPI 3.2.0. - * - * Example: `{ nodeType: "element", name: "isActive" }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions using the modernized + * nodeType approach in OpenAPI 3.2.0. + * + * Example: `{ nodeType: "element", name: "isActive" }` + */ + xml?: XML; } diff --git a/3.2/data-types/composition.ts b/3.2/data-types/composition.ts index 61ea34b..5dd56a8 100644 --- a/3.2/data-types/composition.ts +++ b/3.2/data-types/composition.ts @@ -85,116 +85,116 @@ import type { XML } from "../xml"; * ``` */ export interface CompositionSchema extends Extension { - /** - * An array of schemas that must all be satisfied. - * The value must conform to all schemas in the array. - * - * Example: `[{ type: "object" }, { properties: { name: { type: "string" } } }]` - */ - allOf?: Schema[]; + /** + * An array of schemas that must all be satisfied. + * The value must conform to all schemas in the array. + * + * Example: `[{ type: "object" }, { properties: { name: { type: "string" } } }]` + */ + allOf?: Schema[]; - /** - * An array of schemas where at least one must be satisfied. - * The value must conform to at least one schema in the array. - * - * Example: `[{ type: "string" }, { type: "number" }]` - */ - anyOf?: Schema[]; + /** + * An array of schemas where at least one must be satisfied. + * The value must conform to at least one schema in the array. + * + * Example: `[{ type: "string" }, { type: "number" }]` + */ + anyOf?: Schema[]; - /** - * An array of schemas where exactly one must be satisfied. - * The value must conform to exactly one schema in the array. - * - * Example: `[{ type: "string" }, { type: "number" }]` - */ - oneOf?: Schema[]; + /** + * An array of schemas where exactly one must be satisfied. + * The value must conform to exactly one schema in the array. + * + * Example: `[{ type: "string" }, { type: "number" }]` + */ + oneOf?: Schema[]; - /** - * A schema that must not be satisfied. - * The value must not conform to this schema. - * - * Example: `{ type: "string" }` - */ - not?: Schema; + /** + * A schema that must not be satisfied. + * The value must not conform to this schema. + * + * Example: `{ type: "string" }` + */ + not?: Schema; - /** - * A schema for conditional validation. - * Used with `then` and `else` for conditional logic. - * - * Example: `{ type: "object", properties: { type: { const: "user" } } }` - */ - if?: Schema; + /** + * A schema for conditional validation. + * Used with `then` and `else` for conditional logic. + * + * Example: `{ type: "object", properties: { type: { const: "user" } } }` + */ + if?: Schema; - /** - * A schema to apply if the `if` condition is met. - * The value must conform to this schema if the `if` schema is satisfied. - * - * Example: `{ type: "object", properties: { name: { type: "string" } } }` - */ - then?: Schema; + /** + * A schema to apply if the `if` condition is met. + * The value must conform to this schema if the `if` schema is satisfied. + * + * Example: `{ type: "object", properties: { name: { type: "string" } } }` + */ + then?: Schema; - /** - * A schema to apply if the `if` condition is not met. - * The value must conform to this schema if the `if` schema is not satisfied. - * - * Example: `{ type: "object", properties: { id: { type: "string" } } }` - */ - else?: Schema; + /** + * A schema to apply if the `if` condition is not met. + * The value must conform to this schema if the `if` schema is not satisfied. + * + * Example: `{ type: "object", properties: { id: { type: "string" } } }` + */ + else?: Schema; - /** - * An array of allowed values. - * The value must be one of the values in this array. - * - * Example: `["active", "inactive"]` - */ - enum?: unknown[]; + /** + * An array of allowed values. + * The value must be one of the values in this array. + * + * Example: `["active", "inactive"]` + */ + enum?: unknown[]; - /** - * A single allowed value. - * The value must be exactly this value. - * - * Example: `"active"` - */ - const?: unknown; + /** + * A single allowed value. + * The value must be exactly this value. + * + * Example: `"active"` + */ + const?: unknown; - /** - * An array of example values. - * These are for documentation purposes only. - * - * Example: `["example1", "example2"]` - */ - examples?: unknown[]; + /** + * An array of example values. + * These are for documentation purposes only. + * + * Example: `["example1", "example2"]` + */ + examples?: unknown[]; - /** - * The default value. - * This value will be used if no value is provided. - * - * Example: `"default"` - */ - default?: unknown; + /** + * The default value. + * This value will be used if no value is provided. + * + * Example: `"default"` + */ + default?: unknown; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"Composed Schema"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"Composed Schema"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"A schema composed of multiple schemas"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"A schema composed of multiple schemas"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions using the modernized - * nodeType approach in OpenAPI 3.2.0. - * - * Example: `{ nodeType: "element", name: "composedSchema" }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions using the modernized + * nodeType approach in OpenAPI 3.2.0. + * + * Example: `{ nodeType: "element", name: "composedSchema" }` + */ + xml?: XML; } diff --git a/3.2/data-types/integer.ts b/3.2/data-types/integer.ts index 36a523d..c9e3841 100644 --- a/3.2/data-types/integer.ts +++ b/3.2/data-types/integer.ts @@ -75,114 +75,114 @@ import type { XML } from "../xml"; * ``` */ export interface IntegerSchema extends Extension { - /** - * The type identifier for integer schemas. - * Must be "integer". - */ - type: "integer"; + /** + * The type identifier for integer schemas. + * Must be "integer". + */ + type: "integer"; - /** - * The format of the integer. - * See OpenAPI 3.2.0 Data Type Formats for further details. - * - * Example: `"int32"`, `"int64"` - */ - format?: string; + /** + * The format of the integer. + * See OpenAPI 3.2.0 Data Type Formats for further details. + * + * Example: `"int32"`, `"int64"` + */ + format?: string; - /** - * The integer must be a multiple of this value. - * Must be a positive integer. - * - * Example: `5` - */ - multipleOf?: number; + /** + * The integer must be a multiple of this value. + * Must be a positive integer. + * + * Example: `5` + */ + multipleOf?: number; - /** - * The maximum value of the integer (inclusive). - * The integer must be less than or equal to this value. - * - * Example: `100` - */ - maximum?: number; + /** + * The maximum value of the integer (inclusive). + * The integer must be less than or equal to this value. + * + * Example: `100` + */ + maximum?: number; - /** - * The minimum value of the integer (inclusive). - * The integer must be greater than or equal to this value. - * - * Example: `0` - */ - minimum?: number; + /** + * The minimum value of the integer (inclusive). + * The integer must be greater than or equal to this value. + * + * Example: `0` + */ + minimum?: number; - /** - * The maximum value of the integer (exclusive). - * The integer must be less than this value. - * - * Example: `100` - */ - exclusiveMaximum?: number; + /** + * The maximum value of the integer (exclusive). + * The integer must be less than this value. + * + * Example: `100` + */ + exclusiveMaximum?: number; - /** - * The minimum value of the integer (exclusive). - * The integer must be greater than this value. - * - * Example: `0` - */ - exclusiveMinimum?: number; + /** + * The minimum value of the integer (exclusive). + * The integer must be greater than this value. + * + * Example: `0` + */ + exclusiveMinimum?: number; - /** - * An array of allowed values for the integer. - * The value must be one of the values in this array. - * - * Example: `[1, 2, 3, 4, 5]` - */ - enum?: number[]; + /** + * An array of allowed values for the integer. + * The value must be one of the values in this array. + * + * Example: `[1, 2, 3, 4, 5]` + */ + enum?: number[]; - /** - * A single allowed value for the integer. - * The value must be exactly this value. - * - * Example: `42` - */ - const?: number; + /** + * A single allowed value for the integer. + * The value must be exactly this value. + * + * Example: `42` + */ + const?: number; - /** - * An array of example values for the integer. - * These are for documentation purposes only. - * - * Example: `[1, 2, 3]` - */ - examples?: number[]; + /** + * An array of example values for the integer. + * These are for documentation purposes only. + * + * Example: `[1, 2, 3]` + */ + examples?: number[]; - /** - * The default value for the integer. - * This value will be used if no value is provided. - * - * Example: `0` - */ - default?: number; + /** + * The default value for the integer. + * This value will be used if no value is provided. + * + * Example: `0` + */ + default?: number; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"User ID"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"User ID"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"The unique identifier of the user"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"The unique identifier of the user"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions using the modernized - * nodeType approach in OpenAPI 3.2.0. - * - * Example: `{ nodeType: "element", name: "userId" }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions using the modernized + * nodeType approach in OpenAPI 3.2.0. + * + * Example: `{ nodeType: "element", name: "userId" }` + */ + xml?: XML; } diff --git a/3.2/data-types/number.ts b/3.2/data-types/number.ts index 7183b3f..ce8543e 100644 --- a/3.2/data-types/number.ts +++ b/3.2/data-types/number.ts @@ -75,114 +75,114 @@ import type { XML } from "../xml"; * ``` */ export interface NumberSchema extends Extension { - /** - * The type identifier for number schemas. - * Must be "number". - */ - type: "number"; + /** + * The type identifier for number schemas. + * Must be "number". + */ + type: "number"; - /** - * The format of the number. - * See OpenAPI 3.2.0 Data Type Formats for further details. - * - * Example: `"float"`, `"double"` - */ - format?: string; + /** + * The format of the number. + * See OpenAPI 3.2.0 Data Type Formats for further details. + * + * Example: `"float"`, `"double"` + */ + format?: string; - /** - * The number must be a multiple of this value. - * Must be a positive number. - * - * Example: `0.5` - */ - multipleOf?: number; + /** + * The number must be a multiple of this value. + * Must be a positive number. + * + * Example: `0.5` + */ + multipleOf?: number; - /** - * The maximum value of the number (inclusive). - * The number must be less than or equal to this value. - * - * Example: `100` - */ - maximum?: number; + /** + * The maximum value of the number (inclusive). + * The number must be less than or equal to this value. + * + * Example: `100` + */ + maximum?: number; - /** - * The minimum value of the number (inclusive). - * The number must be greater than or equal to this value. - * - * Example: `0` - */ - minimum?: number; + /** + * The minimum value of the number (inclusive). + * The number must be greater than or equal to this value. + * + * Example: `0` + */ + minimum?: number; - /** - * The maximum value of the number (exclusive). - * The number must be less than this value. - * - * Example: `100` - */ - exclusiveMaximum?: number; + /** + * The maximum value of the number (exclusive). + * The number must be less than this value. + * + * Example: `100` + */ + exclusiveMaximum?: number; - /** - * The minimum value of the number (exclusive). - * The number must be greater than this value. - * - * Example: `0` - */ - exclusiveMinimum?: number; + /** + * The minimum value of the number (exclusive). + * The number must be greater than this value. + * + * Example: `0` + */ + exclusiveMinimum?: number; - /** - * An array of allowed values for the number. - * The value must be one of the values in this array. - * - * Example: `[1, 2, 3, 4, 5]` - */ - enum?: number[]; + /** + * An array of allowed values for the number. + * The value must be one of the values in this array. + * + * Example: `[1, 2, 3, 4, 5]` + */ + enum?: number[]; - /** - * A single allowed value for the number. - * The value must be exactly this value. - * - * Example: `42` - */ - const?: number; + /** + * A single allowed value for the number. + * The value must be exactly this value. + * + * Example: `42` + */ + const?: number; - /** - * An array of example values for the number. - * These are for documentation purposes only. - * - * Example: `[1.5, 2.7, 3.14]` - */ - examples?: number[]; + /** + * An array of example values for the number. + * These are for documentation purposes only. + * + * Example: `[1.5, 2.7, 3.14]` + */ + examples?: number[]; - /** - * The default value for the number. - * This value will be used if no value is provided. - * - * Example: `0` - */ - default?: number; + /** + * The default value for the number. + * This value will be used if no value is provided. + * + * Example: `0` + */ + default?: number; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"Price"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"Price"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"The price of the item"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"The price of the item"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions using the modernized - * nodeType approach in OpenAPI 3.2.0. - * - * Example: `{ nodeType: "element", name: "price" }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions using the modernized + * nodeType approach in OpenAPI 3.2.0. + * + * Example: `{ nodeType: "element", name: "price" }` + */ + xml?: XML; } diff --git a/3.2/data-types/object.ts b/3.2/data-types/object.ts index 5c649ad..1d4874e 100644 --- a/3.2/data-types/object.ts +++ b/3.2/data-types/object.ts @@ -89,140 +89,140 @@ import type { XML } from "../xml"; * ``` */ export interface ObjectSchema extends Extension { - /** - * The type identifier for object schemas. - * Must be "object". - */ - type: "object"; + /** + * The type identifier for object schemas. + * Must be "object". + */ + type: "object"; - /** - * A map of property names to their schemas. - * Each property in the object must conform to its corresponding schema. - * - * Example: `{ name: { type: "string" }, age: { type: "number" } }` - */ - properties?: Record; + /** + * A map of property names to their schemas. + * Each property in the object must conform to its corresponding schema. + * + * Example: `{ name: { type: "string" }, age: { type: "number" } }` + */ + properties?: Record; - /** - * An array of required property names. - * These properties must be present in the object. - * - * Example: `["name", "email"]` - */ - required?: string[]; + /** + * An array of required property names. + * These properties must be present in the object. + * + * Example: `["name", "email"]` + */ + required?: string[]; - /** - * The schema for additional properties not defined in properties. - * If false, no additional properties are allowed. - * If true, any additional properties are allowed. - * If a schema, additional properties must conform to this schema. - * - * Example: `{ type: "string" }` or `false` or `true` - */ - additionalProperties?: Schema | boolean; + /** + * The schema for additional properties not defined in properties. + * If false, no additional properties are allowed. + * If true, any additional properties are allowed. + * If a schema, additional properties must conform to this schema. + * + * Example: `{ type: "string" }` or `false` or `true` + */ + additionalProperties?: Schema | boolean; - /** - * A map of regex patterns to schemas. - * Properties whose names match a pattern must conform to the corresponding schema. - * - * Example: `{ "^S_": { type: "string" } }` - */ - patternProperties?: Record; + /** + * A map of regex patterns to schemas. + * Properties whose names match a pattern must conform to the corresponding schema. + * + * Example: `{ "^S_": { type: "string" } }` + */ + patternProperties?: Record; - /** - * The schema for property names. - * All property names in the object must conform to this schema. - * - * Example: `{ type: "string", pattern: "^[A-Za-z][A-Za-z0-9]*$" }` - */ - propertyNames?: Schema; + /** + * The schema for property names. + * All property names in the object must conform to this schema. + * + * Example: `{ type: "string", pattern: "^[A-Za-z][A-Za-z0-9]*$" }` + */ + propertyNames?: Schema; - /** - * The minimum number of properties in the object. - * Must be a non-negative integer. - * - * Example: `1` - */ - minProperties?: number; + /** + * The minimum number of properties in the object. + * Must be a non-negative integer. + * + * Example: `1` + */ + minProperties?: number; - /** - * The maximum number of properties in the object. - * Must be a non-negative integer. - * - * Example: `10` - */ - maxProperties?: number; + /** + * The maximum number of properties in the object. + * Must be a non-negative integer. + * + * Example: `10` + */ + maxProperties?: number; - /** - * A map of property names to arrays of required properties. - * If a property is present, the properties in its array must also be present. - * - * Example: `{ credit_card: ["billing_address"] }` - */ - dependentRequired?: Record; + /** + * A map of property names to arrays of required properties. + * If a property is present, the properties in its array must also be present. + * + * Example: `{ credit_card: ["billing_address"] }` + */ + dependentRequired?: Record; - /** - * A map of property names to schemas. - * If a property is present, the object must conform to the corresponding schema. - * - * Example: `{ credit_card: { type: "object", properties: { number: { type: "string" } } } }` - */ - dependentSchemas?: Record; + /** + * A map of property names to schemas. + * If a property is present, the object must conform to the corresponding schema. + * + * Example: `{ credit_card: { type: "object", properties: { number: { type: "string" } } } }` + */ + dependentSchemas?: Record; - /** - * An array of allowed values for the object. - * The value must be one of the values in this array. - * - * Example: `[{ name: "John" }, { name: "Jane" }]` - */ - enum?: Record[]; + /** + * An array of allowed values for the object. + * The value must be one of the values in this array. + * + * Example: `[{ name: "John" }, { name: "Jane" }]` + */ + enum?: Record[]; - /** - * A single allowed value for the object. - * The value must be exactly this value. - * - * Example: `{ name: "John" }` - */ - const?: Record; + /** + * A single allowed value for the object. + * The value must be exactly this value. + * + * Example: `{ name: "John" }` + */ + const?: Record; - /** - * An array of example values for the object. - * These are for documentation purposes only. - * - * Example: `[{ name: "John", age: 30 }]` - */ - examples?: Record[]; + /** + * An array of example values for the object. + * These are for documentation purposes only. + * + * Example: `[{ name: "John", age: 30 }]` + */ + examples?: Record[]; - /** - * The default value for the object. - * This value will be used if no value is provided. - * - * Example: `{}` - */ - default?: Record; + /** + * The default value for the object. + * This value will be used if no value is provided. + * + * Example: `{}` + */ + default?: Record; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"User"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"User"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"A user object"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"A user object"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions using the modernized - * nodeType approach in OpenAPI 3.2.0. - * - * Example: `{ nodeType: "element", name: "user" }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions using the modernized + * nodeType approach in OpenAPI 3.2.0. + * + * Example: `{ nodeType: "element", name: "user" }` + */ + xml?: XML; } diff --git a/3.2/data-types/reference.ts b/3.2/data-types/reference.ts index 9329847..8ac6f69 100644 --- a/3.2/data-types/reference.ts +++ b/3.2/data-types/reference.ts @@ -52,19 +52,19 @@ import type { Extension } from "../extensions"; * ``` */ export interface ReferenceSchema extends Extension { - /** - * A reference to a schema. This MUST be in the form of a URI. - * When present, no other properties except `description` and extensions are allowed. - * - * Example: `"#/components/schemas/User"` - */ - $ref: string; + /** + * A reference to a schema. This MUST be in the form of a URI. + * When present, no other properties except `description` and extensions are allowed. + * + * Example: `"#/components/schemas/User"` + */ + $ref: string; - /** - * A description of the referenced schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"Reference to a user schema"` - */ - description?: string; + /** + * A description of the referenced schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"Reference to a user schema"` + */ + description?: string; } diff --git a/3.2/data-types/string.ts b/3.2/data-types/string.ts index 19aad04..c025836 100644 --- a/3.2/data-types/string.ts +++ b/3.2/data-types/string.ts @@ -72,98 +72,98 @@ import type { XML } from "../xml"; * ``` */ export interface StringSchema extends Extension { - /** - * The type identifier for string schemas. - * Must be "string". - */ - type: "string"; + /** + * The type identifier for string schemas. + * Must be "string". + */ + type: "string"; - /** - * The format of the string. - * See OpenAPI 3.2.0 Data Type Formats for further details. - * - * Example: `"email"`, `"date-time"`, `"uuid"` - */ - format?: string; + /** + * The format of the string. + * See OpenAPI 3.2.0 Data Type Formats for further details. + * + * Example: `"email"`, `"date-time"`, `"uuid"` + */ + format?: string; - /** - * The maximum length of the string. - * Must be a non-negative integer. - * - * Example: `255` - */ - maxLength?: number; + /** + * The maximum length of the string. + * Must be a non-negative integer. + * + * Example: `255` + */ + maxLength?: number; - /** - * The minimum length of the string. - * Must be a non-negative integer. - * - * Example: `1` - */ - minLength?: number; + /** + * The minimum length of the string. + * Must be a non-negative integer. + * + * Example: `1` + */ + minLength?: number; - /** - * A regular expression pattern that the string must match. - * Should be a valid ECMA 262 regular expression. - * - * Example: `"^[A-Za-z0-9]+$"` - */ - pattern?: string; + /** + * A regular expression pattern that the string must match. + * Should be a valid ECMA 262 regular expression. + * + * Example: `"^[A-Za-z0-9]+$"` + */ + pattern?: string; - /** - * An array of allowed values for the string. - * The value must be one of the values in this array. - * - * Example: `["active", "inactive", "pending"]` - */ - enum?: string[]; + /** + * An array of allowed values for the string. + * The value must be one of the values in this array. + * + * Example: `["active", "inactive", "pending"]` + */ + enum?: string[]; - /** - * A single allowed value for the string. - * The value must be exactly this value. - * - * Example: `"active"` - */ - const?: string; + /** + * A single allowed value for the string. + * The value must be exactly this value. + * + * Example: `"active"` + */ + const?: string; - /** - * An array of example values for the string. - * These are for documentation purposes only. - * - * Example: `["example@email.com", "test@domain.com"]` - */ - examples?: string[]; + /** + * An array of example values for the string. + * These are for documentation purposes only. + * + * Example: `["example@email.com", "test@domain.com"]` + */ + examples?: string[]; - /** - * The default value for the string. - * This value will be used if no value is provided. - * - * Example: `"default"` - */ - default?: string; + /** + * The default value for the string. + * This value will be used if no value is provided. + * + * Example: `"default"` + */ + default?: string; - /** - * A short title for the schema. - * This is for documentation purposes only. - * - * Example: `"User Email"` - */ - title?: string; + /** + * A short title for the schema. + * This is for documentation purposes only. + * + * Example: `"User Email"` + */ + title?: string; - /** - * A description of the schema. - * CommonMark syntax MAY be used for rich text representation. - * - * Example: `"The email address of the user"` - */ - description?: string; + /** + * A description of the schema. + * CommonMark syntax MAY be used for rich text representation. + * + * Example: `"The email address of the user"` + */ + description?: string; - /** - * XML representation metadata for the schema. - * Allows for fine-tuned XML model definitions using the modernized - * nodeType approach in OpenAPI 3.2.0. - * - * Example: `{ nodeType: "element", name: "userName" }` - */ - xml?: XML; + /** + * XML representation metadata for the schema. + * Allows for fine-tuned XML model definitions using the modernized + * nodeType approach in OpenAPI 3.2.0. + * + * Example: `{ nodeType: "element", name: "userName" }` + */ + xml?: XML; } diff --git a/3.2/extensions.ts b/3.2/extensions.ts index 4cb793c..addff58 100644 --- a/3.2/extensions.ts +++ b/3.2/extensions.ts @@ -50,13 +50,13 @@ * ``` */ export interface Extension { - /** - * Specification Extensions allow adding custom properties to OpenAPI objects. - * All extension properties must start with `x-` and can contain any valid JSON value. - * - * @example "x-custom-property" - * @example "x-internal-id" - * @example "x-codegen-settings" - */ - [key: `x-${string}`]: unknown; + /** + * Specification Extensions allow adding custom properties to OpenAPI objects. + * All extension properties must start with `x-` and can contain any valid JSON value. + * + * @example "x-custom-property" + * @example "x-internal-id" + * @example "x-codegen-settings" + */ + [key: `x-${string}`]: unknown; } diff --git a/3.2/externalDocs.ts b/3.2/externalDocs.ts index a945e7e..a292bc3 100644 --- a/3.2/externalDocs.ts +++ b/3.2/externalDocs.ts @@ -42,21 +42,21 @@ import type { Extension } from "./extensions"; * ``` */ export interface ExternalDocumentation extends Extension { - /** - * A short description of the target documentation. CommonMark syntax MAY be used - * for rich text representation. - * - * @example "Find out more about our API" - * @example "Additional documentation for this endpoint" - */ - description?: string; + /** + * A short description of the target documentation. CommonMark syntax MAY be used + * for rich text representation. + * + * @example "Find out more about our API" + * @example "Additional documentation for this endpoint" + */ + description?: string; - /** - * The URL for the target documentation. This field is required and MUST be in the - * format of a URL. - * - * @example "https://example.com/docs" - * @example "https://docs.example.com/api" - */ - url: string; + /** + * The URL for the target documentation. This field is required and MUST be in the + * format of a URL. + * + * @example "https://example.com/docs" + * @example "https://docs.example.com/api" + */ + url: string; } diff --git a/3.2/index.ts b/3.2/index.ts index 60669a5..a68140c 100644 --- a/3.2/index.ts +++ b/3.2/index.ts @@ -15,14 +15,14 @@ export type { Components } from "./components"; // Re-export data-types for convenience export type { - ArraySchema, - BooleanSchema, - CompositionSchema, - IntegerSchema, - NumberSchema, - ObjectSchema, - ReferenceSchema, - StringSchema, + ArraySchema, + BooleanSchema, + CompositionSchema, + IntegerSchema, + NumberSchema, + ObjectSchema, + ReferenceSchema, + StringSchema, } from "./data-types"; // Core OpenAPI types export type { Extension } from "./extensions"; diff --git a/3.2/info.ts b/3.2/info.ts index 97c5f05..2e9904b 100644 --- a/3.2/info.ts +++ b/3.2/info.ts @@ -61,103 +61,103 @@ import type { Extension } from "./extensions"; * ``` */ export interface Info extends Extension { - /** - * The title of the API. - * This field is required and should be descriptive of the API. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - title} | - * - * @property `title` - Required The title of the API - * - * @example "Pet Store API" - */ - title: string; + /** + * The title of the API. + * This field is required and should be descriptive of the API. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - title} | + * + * @property `title` - Required The title of the API + * + * @example "Pet Store API" + */ + title: string; - /** - * A short summary of the API. - * This should be a brief description of what the API does. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - summary} | - * - * @property `summary` - Optional A short summary of the API - * - * @example "A sample API that uses a petstore as an example" - */ - summary?: string; + /** + * A short summary of the API. + * This should be a brief description of what the API does. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - summary} | + * + * @property `summary` - Optional A short summary of the API + * + * @example "A sample API that uses a petstore as an example" + */ + summary?: string; - /** - * A description of the API. - * CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - description} | - * - * @property `description` - Optional A description of the API - * - * @example "This is a sample server Petstore server." - */ - description?: string; + /** + * A description of the API. + * CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - description} | + * + * @property `description` - Optional A description of the API + * + * @example "This is a sample server Petstore server." + */ + description?: string; - /** - * A URL to the Terms of Service for the API. - * This MUST be in the format of a URL. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - termsOfService} | - * - * @property `termsOfService` - Optional A URL to the Terms of Service for the API - * - * @example "http://example.com/terms/" - */ - termsOfService?: string; + /** + * A URL to the Terms of Service for the API. + * This MUST be in the format of a URL. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - termsOfService} | + * + * @property `termsOfService` - Optional A URL to the Terms of Service for the API + * + * @example "http://example.com/terms/" + */ + termsOfService?: string; - /** - * The contact information for the exposed API. - * This object contains contact details for the API. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - contact} | - * - * @property `contact` - Optional The contact information for the exposed API - * - * @example { name: "API Support", email: "support@example.com" } - */ - contact?: Contact; + /** + * The contact information for the exposed API. + * This object contains contact details for the API. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - contact} | + * + * @property `contact` - Optional The contact information for the exposed API + * + * @example { name: "API Support", email: "support@example.com" } + */ + contact?: Contact; - /** - * The license information for the exposed API. - * This object contains license details for the API. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - license} | - * - * @property `license` - Optional The license information for the exposed API - * - * @example { name: "Apache 2.0", url: "https://www.apache.org/licenses/LICENSE-2.0.html" } - */ - license?: License; + /** + * The license information for the exposed API. + * This object contains license details for the API. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - license} | + * + * @property `license` - Optional The license information for the exposed API + * + * @example { name: "Apache 2.0", url: "https://www.apache.org/licenses/LICENSE-2.0.html" } + */ + license?: License; - /** - * The version of the OpenAPI document. - * This field is required and should follow semantic versioning. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - version} | - * - * @property `version` - Required The version of the OpenAPI document - * - * @example "1.0.0" - */ - version: string; + /** + * The version of the OpenAPI document. + * This field is required and should follow semantic versioning. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object | OpenAPI 3.2.0 Info Object - version} | + * + * @property `version` - Required The version of the OpenAPI document + * + * @example "1.0.0" + */ + version: string; } /** @@ -217,49 +217,49 @@ export interface Info extends Extension { * ``` */ export interface Contact extends Extension { - /** - * The identifying name of the contact person/organization. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object | OpenAPI 3.2.0 Contact Object - name} | - * - * @property `name` - Optional The identifying name of the contact person/organization - * - * @example "API Support" - * @example "John Doe" - */ - name?: string; + /** + * The identifying name of the contact person/organization. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object | OpenAPI 3.2.0 Contact Object - name} | + * + * @property `name` - Optional The identifying name of the contact person/organization + * + * @example "API Support" + * @example "John Doe" + */ + name?: string; - /** - * The URL pointing to the contact information. - * MUST be in the format of a URL. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object | OpenAPI 3.2.0 Contact Object - url} | - * - * @property `url` - Optional A URL pointing to the contact information - * - * @example "http://www.acme.com/support" - * @example "https://example.com/contact" - */ - url?: string; + /** + * The URL pointing to the contact information. + * MUST be in the format of a URL. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object | OpenAPI 3.2.0 Contact Object - url} | + * + * @property `url` - Optional A URL pointing to the contact information + * + * @example "http://www.acme.com/support" + * @example "https://example.com/contact" + */ + url?: string; - /** - * The email address of the contact person/organization. - * MUST be in the format of an email address. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object | OpenAPI 3.2.0 Contact Object - email} | - * - * @property `email` - Optional The email address of the contact person/organization - * - * @example "support@acme.com" - * @example "contact@example.com" - */ - email?: string; + /** + * The email address of the contact person/organization. + * MUST be in the format of an email address. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object | OpenAPI 3.2.0 Contact Object - email} | + * + * @property `email` - Optional The email address of the contact person/organization + * + * @example "support@acme.com" + * @example "contact@example.com" + */ + email?: string; } /** @@ -316,35 +316,35 @@ export interface Contact extends Extension { * ``` */ export interface License extends Extension { - /** - * The license name used for the API. - * This field is required. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object | OpenAPI 3.2.0 License Object - name} | - * - * @property `name` - Required The license name used for the API - * - * @example "Apache 2.0" - * @example "MIT" - * @example "Proprietary License" - */ - name: string; + /** + * The license name used for the API. + * This field is required. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object | OpenAPI 3.2.0 License Object - name} | + * + * @property `name` - Required The license name used for the API + * + * @example "Apache 2.0" + * @example "MIT" + * @example "Proprietary License" + */ + name: string; - /** - * A URL to the license used for the API. - * MUST be in the format of a URL. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object | OpenAPI 3.2.0 License Object - url} | - * - * @property `url` - Optional A URL to the license used for the API - * - * @example "https://www.apache.org/licenses/LICENSE-2.0.html" - * @example "https://opensource.org/licenses/MIT" - * @example "https://example.com/licenses/proprietary-1.0" - */ - url?: string; + /** + * A URL to the license used for the API. + * MUST be in the format of a URL. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object | OpenAPI 3.2.0 License Object - url} | + * + * @property `url` - Optional A URL to the license used for the API + * + * @example "https://www.apache.org/licenses/LICENSE-2.0.html" + * @example "https://opensource.org/licenses/MIT" + * @example "https://example.com/licenses/proprietary-1.0" + */ + url?: string; } diff --git a/3.2/oauth.ts b/3.2/oauth.ts index cd8dfd2..2c83931 100644 --- a/3.2/oauth.ts +++ b/3.2/oauth.ts @@ -64,45 +64,45 @@ import type { Extension } from "./extensions"; * ``` */ export interface OAuthFlow extends Extension { - /** - * The authorization URL to be used for this flow. - * This MUST be in the form of a URL. - * - * Example: `"https://example.com/oauth/authorize"` - */ - authorizationUrl?: string; + /** + * The authorization URL to be used for this flow. + * This MUST be in the form of a URL. + * + * Example: `"https://example.com/oauth/authorize"` + */ + authorizationUrl?: string; - /** - * The token URL to be used for this flow. - * This MUST be in the form of a URL. - * - * Example: `"https://example.com/oauth/token"` - */ - tokenUrl?: string; + /** + * The token URL to be used for this flow. + * This MUST be in the form of a URL. + * + * Example: `"https://example.com/oauth/token"` + */ + tokenUrl?: string; - /** - * The URL to be used for obtaining refresh tokens. - * This MUST be in the form of a URL. - * - * Example: `"https://example.com/oauth/refresh"` - */ - refreshUrl?: string; + /** + * The URL to be used for obtaining refresh tokens. + * This MUST be in the form of a URL. + * + * Example: `"https://example.com/oauth/refresh"` + */ + refreshUrl?: string; - /** - * A map between the scope name and a short description for it. - * The map MAY be empty. - * - * Example: `{ "read": "Read access to user data", "write": "Write access to user data" }` - */ - scopes: Record; + /** + * A map between the scope name and a short description for it. + * The map MAY be empty. + * + * Example: `{ "read": "Read access to user data", "write": "Write access to user data" }` + */ + scopes: Record; - /** - * The URL to be used for OAuth 2.0 metadata. - * This MUST be in the form of a URL. - * - * Example: `"https://example.com/.well-known/oauth-authorization-server"` - */ - oauth2MetadataUrl?: string; + /** + * The URL to be used for OAuth 2.0 metadata. + * This MUST be in the form of a URL. + * + * Example: `"https://example.com/.well-known/oauth-authorization-server"` + */ + oauth2MetadataUrl?: string; } /** @@ -181,43 +181,43 @@ export interface OAuthFlow extends Extension { * ``` */ export interface OAuthFlows extends Extension { - /** - * Configuration for the OAuth Implicit flow. - * This flow is deprecated in OAuth 2.1. - * - * Example: `{ authorizationUrl: "https://example.com/oauth/authorize", scopes: { "read": "Read access" } }` - */ - implicit?: OAuthFlow; + /** + * Configuration for the OAuth Implicit flow. + * This flow is deprecated in OAuth 2.1. + * + * Example: `{ authorizationUrl: "https://example.com/oauth/authorize", scopes: { "read": "Read access" } }` + */ + implicit?: OAuthFlow; - /** - * Configuration for the OAuth Resource Owner Password flow. - * This flow is deprecated in OAuth 2.1. - * - * Example: `{ tokenUrl: "https://example.com/oauth/token", scopes: { "read": "Read access" } }` - */ - password?: OAuthFlow; + /** + * Configuration for the OAuth Resource Owner Password flow. + * This flow is deprecated in OAuth 2.1. + * + * Example: `{ tokenUrl: "https://example.com/oauth/token", scopes: { "read": "Read access" } }` + */ + password?: OAuthFlow; - /** - * Configuration for the OAuth Client Credentials flow. - * This flow is suitable for machine-to-machine authentication. - * - * Example: `{ tokenUrl: "https://example.com/oauth/token", scopes: { "api": "Full API access" } }` - */ - clientCredentials?: OAuthFlow; + /** + * Configuration for the OAuth Client Credentials flow. + * This flow is suitable for machine-to-machine authentication. + * + * Example: `{ tokenUrl: "https://example.com/oauth/token", scopes: { "api": "Full API access" } }` + */ + clientCredentials?: OAuthFlow; - /** - * Configuration for the OAuth Authorization Code flow. - * This is the recommended flow for web applications. - * - * Example: `{ authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token", scopes: { "read": "Read access" } }` - */ - authorizationCode?: OAuthFlow; + /** + * Configuration for the OAuth Authorization Code flow. + * This is the recommended flow for web applications. + * + * Example: `{ authorizationUrl: "https://example.com/oauth/authorize", tokenUrl: "https://example.com/oauth/token", scopes: { "read": "Read access" } }` + */ + authorizationCode?: OAuthFlow; - /** - * Configuration for the OAuth Device Authorization flow. - * This flow is suitable for devices with limited input capabilities. - * - * Example: `{ deviceCodeUrl: "https://example.com/oauth/device", tokenUrl: "https://example.com/oauth/token", scopes: { "read": "Read access" } }` - */ - deviceAuthorization?: OAuthFlow; + /** + * Configuration for the OAuth Device Authorization flow. + * This flow is suitable for devices with limited input capabilities. + * + * Example: `{ deviceCodeUrl: "https://example.com/oauth/device", tokenUrl: "https://example.com/oauth/token", scopes: { "read": "Read access" } }` + */ + deviceAuthorization?: OAuthFlow; } diff --git a/3.2/paths.ts b/3.2/paths.ts index ec60fb4..a14b3e8 100644 --- a/3.2/paths.ts +++ b/3.2/paths.ts @@ -60,149 +60,149 @@ import type { ResponsesMap } from "./status"; * ``` */ export interface PathItem extends Extension { - /** - * An optional, string summary, intended to apply to all operations in this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - summary} | - * - * @property `summary` - Optional An optional, string summary, intended to apply to all operations in this path - * - * @example "Pet operations" - * @example "User management" - */ - summary?: string; + /** + * An optional, string summary, intended to apply to all operations in this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - summary} | + * + * @property `summary` - Optional An optional, string summary, intended to apply to all operations in this path + * + * @example "Pet operations" + * @example "User management" + */ + summary?: string; - /** - * An optional, string description, intended to apply to all operations in this path. - * CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - description} | - * - * @property `description` - Optional An optional, string description, intended to apply to all operations in this path - * - * @example "Operations related to pet management" - * @example "All user-related operations" - */ - description?: string; + /** + * An optional, string description, intended to apply to all operations in this path. + * CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - description} | + * + * @property `description` - Optional An optional, string description, intended to apply to all operations in this path + * + * @example "Operations related to pet management" + * @example "All user-related operations" + */ + description?: string; - /** - * A definition of a GET operation on this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - get} | - * - * @property `get` - Optional A definition of a GET operation on this path - */ - get?: Operation; + /** + * A definition of a GET operation on this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - get} | + * + * @property `get` - Optional A definition of a GET operation on this path + */ + get?: Operation; - /** - * A definition of a PUT operation on this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - put} | - * - * @property `put` - Optional A definition of a PUT operation on this path - */ - put?: Operation; + /** + * A definition of a PUT operation on this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - put} | + * + * @property `put` - Optional A definition of a PUT operation on this path + */ + put?: Operation; - /** - * A definition of a POST operation on this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - post} | - * - * @property `post` - Optional A definition of a POST operation on this path - */ - post?: Operation; + /** + * A definition of a POST operation on this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - post} | + * + * @property `post` - Optional A definition of a POST operation on this path + */ + post?: Operation; - /** - * A definition of a DELETE operation on this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - delete} | - * - * @property `delete` - Optional A definition of a DELETE operation on this path - */ - delete?: Operation; + /** + * A definition of a DELETE operation on this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - delete} | + * + * @property `delete` - Optional A definition of a DELETE operation on this path + */ + delete?: Operation; - /** - * A definition of an OPTIONS operation on this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - options} | - * - * @property `options` - Optional A definition of an OPTIONS operation on this path - */ - options?: Operation; + /** + * A definition of an OPTIONS operation on this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - options} | + * + * @property `options` - Optional A definition of an OPTIONS operation on this path + */ + options?: Operation; - /** - * A definition of a HEAD operation on this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - head} | - * - * @property `head` - Optional A definition of a HEAD operation on this path - */ - head?: Operation; + /** + * A definition of a HEAD operation on this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - head} | + * + * @property `head` - Optional A definition of a HEAD operation on this path + */ + head?: Operation; - /** - * A definition of a PATCH operation on this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - patch} | - * - * @property `patch` - Optional A definition of a PATCH operation on this path - */ - patch?: Operation; + /** + * A definition of a PATCH operation on this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - patch} | + * + * @property `patch` - Optional A definition of a PATCH operation on this path + */ + patch?: Operation; - /** - * A definition of a TRACE operation on this path. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - trace} | - * - * @property `trace` - Optional A definition of a TRACE operation on this path - */ - trace?: Operation; + /** + * A definition of a TRACE operation on this path. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - trace} | + * + * @property `trace` - Optional A definition of a TRACE operation on this path + */ + trace?: Operation; - /** - * An alternative server array to service all operations in this path. - * If an alternative server object is specified at the Path Item Object level, - * it will override the server object defined at the root level. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - servers} | - * - * @property `servers` - Optional An alternative server array to service all operations in this path - */ - servers?: Server[]; + /** + * An alternative server array to service all operations in this path. + * If an alternative server object is specified at the Path Item Object level, + * it will override the server object defined at the root level. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - servers} | + * + * @property `servers` - Optional An alternative server array to service all operations in this path + */ + servers?: Server[]; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - parameters} | - * - * @property `parameters` - Optional A list of parameters that are applicable for all the operations described under this path - */ - parameters?: Parameter[]; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object | OpenAPI 3.2.0 Path Item Object - parameters} | + * + * @property `parameters` - Optional A list of parameters that are applicable for all the operations described under this path + */ + parameters?: Parameter[]; } /** @@ -254,152 +254,152 @@ export interface PathItem extends Extension { * ``` */ export interface Operation extends Extension { - /** - * A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - tags} | - * - * @property `tags` - Optional A list of tags for API documentation control - * - * @example ["pets", "list"] - * @example ["users", "authentication"] - */ - tags?: string[]; + /** + * A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - tags} | + * + * @property `tags` - Optional A list of tags for API documentation control + * + * @example ["pets", "list"] + * @example ["users", "authentication"] + */ + tags?: string[]; - /** - * A short summary of what the operation does. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - summary} | - * - * @property `summary` - Optional A short summary of what the operation does - * - * @example "List all pets" - * @example "Create a new user" - */ - summary?: string; + /** + * A short summary of what the operation does. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - summary} | + * + * @property `summary` - Optional A short summary of what the operation does + * + * @example "List all pets" + * @example "Create a new user" + */ + summary?: string; - /** - * A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - description} | - * - * @property `description` - Optional A verbose explanation of the operation behavior - * - * @example "Returns a list of all pets in the system" - * @example "Creates a new user account with the provided information" - */ - description?: string; + /** + * A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - description} | + * + * @property `description` - Optional A verbose explanation of the operation behavior + * + * @example "Returns a list of all pets in the system" + * @example "Creates a new user account with the provided information" + */ + description?: string; - /** - * Additional external documentation for this operation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - externalDocs} | - * - * @property `externalDocs` - Optional Additional external documentation for this operation - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for this operation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - externalDocs} | + * + * @property `externalDocs` - Optional Additional external documentation for this operation + */ + externalDocs?: ExternalDocumentation; - /** - * Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - operationId} | - * - * @property `operationId` - Optional Unique string used to identify the operation - * - * @example "listPets" - * @example "createUser" - */ - operationId?: string; + /** + * Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - operationId} | + * + * @property `operationId` - Optional Unique string used to identify the operation + * + * @example "listPets" + * @example "createUser" + */ + operationId?: string; - /** - * A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item level, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - parameters} | - * - * @property `parameters` - Optional A list of parameters that are applicable for this operation - */ - parameters?: Parameter[]; + /** + * A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item level, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - parameters} | + * + * @property `parameters` - Optional A list of parameters that are applicable for this operation + */ + parameters?: Parameter[]; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - requestBody} | - * - * @property `requestBody` - Optional The request body applicable for this operation - */ - requestBody?: RequestBody; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - requestBody} | + * + * @property `requestBody` - Optional The request body applicable for this operation + */ + requestBody?: RequestBody; - /** - * The list of possible responses as they are returned from executing this operation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - responses} | - * - * @property `responses` - Optional The list of possible responses as they are returned from executing this operation - */ - responses?: ResponsesMap; + /** + * The list of possible responses as they are returned from executing this operation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - responses} | + * + * @property `responses` - Optional The list of possible responses as they are returned from executing this operation + */ + responses?: ResponsesMap; - /** - * A map of possible out-of band callbacks related to the parent operation. 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - callbacks} | - * - * @property `callbacks` - Optional A map of possible out-of band callbacks related to the parent operation - */ - callbacks?: Record; + /** + * A map of possible out-of band callbacks related to the parent operation. 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - callbacks} | + * + * @property `callbacks` - Optional A map of possible out-of band callbacks related to the parent operation + */ + callbacks?: Record; - /** - * Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - deprecated} | - * - * @property `deprecated` - Optional Declares this operation to be deprecated - * - * @example true - * @example false - */ - deprecated?: boolean; + /** + * Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - deprecated} | + * + * @property `deprecated` - Optional Declares this operation to be deprecated + * + * @example true + * @example false + */ + deprecated?: boolean; - /** - * A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level security. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - security} | - * - * @property `security` - Optional A declaration of which security mechanisms can be used for this operation - */ - security?: SecurityRequirement[]; + /** + * A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level security. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - security} | + * + * @property `security` - Optional A declaration of which security mechanisms can be used for this operation + */ + security?: SecurityRequirement[]; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - servers} | - * - * @property `servers` - Optional An alternative server array to service this operation - */ - servers?: Server[]; + /** + * An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object | OpenAPI 3.2.0 Operation Object - servers} | + * + * @property `servers` - Optional An alternative server array to service this operation + */ + servers?: Server[]; } /** @@ -462,222 +462,222 @@ export interface Operation extends Extension { * ``` */ export interface Parameter extends Extension { - /** - * The name of the parameter. Parameter names are case sensitive. - * - If in is "path", the name field MUST correspond to the associated path segment - * - 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 - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - name} | - * - * @property `name` - Required The name of the parameter - * - * @example "id" - * @example "limit" - * @example "user" - */ - name: string; + /** + * The name of the parameter. Parameter names are case sensitive. + * - If in is "path", the name field MUST correspond to the associated path segment + * - 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 + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - name} | + * + * @property `name` - Required The name of the parameter + * + * @example "id" + * @example "limit" + * @example "user" + */ + name: string; - /** - * The location of the parameter. Possible values are "query", "header", "path" or "cookie". - * - * - **query**: Parameters that are appended to the URL - * - **header**: Custom headers that are expected as part of the request - * - **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL - * - **cookie**: Used to pass a specific cookie value to the API - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - in} | - * - * @property `in` - Required The location of the parameter - * - * @example "query" - * @example "path" - * @example "header" - * @example "cookie" - */ - in: "query" | "header" | "path" | "cookie"; + /** + * The location of the parameter. Possible values are "query", "header", "path" or "cookie". + * + * - **query**: Parameters that are appended to the URL + * - **header**: Custom headers that are expected as part of the request + * - **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL + * - **cookie**: Used to pass a specific cookie value to the API + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - in} | + * + * @property `in` - Required The location of the parameter + * + * @example "query" + * @example "path" + * @example "header" + * @example "cookie" + */ + in: "query" | "header" | "path" | "cookie"; - /** - * A brief description of the parameter. This could contain examples of use. - * CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - description} | - * - * @property `description` - Optional A brief description of the parameter - * - * @example "User ID to retrieve" - * @example "Number of items to return" - */ - description?: string; + /** + * A brief description of the parameter. This could contain examples of use. + * CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - description} | + * + * @property `description` - Optional A brief description of the parameter + * + * @example "User ID to retrieve" + * @example "Number of items to return" + */ + description?: string; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - required} | - * - * @property `required` - Optional Determines whether this parameter is mandatory - * - * @example true - * @example false - */ - required?: boolean; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - required} | + * + * @property `required` - Optional Determines whether this parameter is mandatory + * + * @example true + * @example false + */ + required?: boolean; - /** - * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - deprecated} | - * - * @property `deprecated` - Optional Specifies that a parameter is deprecated and SHOULD be transitioned out of usage - * - * @example true - * @example false - */ - deprecated?: boolean; + /** + * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - deprecated} | + * + * @property `deprecated` - Optional Specifies that a parameter is deprecated and SHOULD be transitioned out of usage + * + * @example true + * @example false + */ + deprecated?: boolean; - /** - * Sets the ability to pass empty-valued parameters. This is valid only for query - * parameters and allows sending a parameter with an empty value. Default value is false. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - allowEmptyValue} | - * - * @property `allowEmptyValue` - Optional Sets the ability to pass empty-valued parameters - * - * @example true - * @example false - */ - allowEmptyValue?: boolean; + /** + * Sets the ability to pass empty-valued parameters. This is valid only for query + * parameters and allows sending a parameter with an empty value. Default value is false. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - allowEmptyValue} | + * + * @property `allowEmptyValue` - Optional Sets the ability to pass empty-valued parameters + * + * @example true + * @example false + */ + allowEmptyValue?: boolean; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - style} | - * - * @property `style` - Optional Describes how the parameter value will be serialized - * - * @example "form" - * @example "simple" - * @example "matrix" - * @example "label" - * @example "spaceDelimited" - * @example "pipeDelimited" - * @example "deepObject" - */ - style?: - | "matrix" - | "label" - | "form" - | "simple" - | "spaceDelimited" - | "pipeDelimited" - | "deepObject"; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - style} | + * + * @property `style` - Optional Describes how the parameter value will be serialized + * + * @example "form" + * @example "simple" + * @example "matrix" + * @example "label" + * @example "spaceDelimited" + * @example "pipeDelimited" + * @example "deepObject" + */ + style?: + | "matrix" + | "label" + | "form" + | "simple" + | "spaceDelimited" + | "pipeDelimited" + | "deepObject"; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - explode} | - * - * @property `explode` - Optional When this is true, parameter values of type array or object generate separate parameters - * - * @example true - * @example false - */ - explode?: boolean; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - explode} | + * + * @property `explode` - Optional When this is true, parameter values of type array or object generate separate parameters + * + * @example true + * @example false + */ + explode?: boolean; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - allowReserved} | - * - * @property `allowReserved` - Optional Determines whether the parameter value SHOULD allow reserved characters - * - * @example true - * @example false - */ - allowReserved?: boolean; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - allowReserved} | + * + * @property `allowReserved` - Optional Determines whether the parameter value SHOULD allow reserved characters + * + * @example true + * @example false + */ + allowReserved?: boolean; - /** - * The schema defining the type used for the parameter. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - schema} | - * - * @property `schema` - Optional The schema defining the type used for the parameter - * - * @example { type: "string" } - * @example { type: "integer", minimum: 1, maximum: 100 } - */ - schema?: Schema; + /** + * The schema defining the type used for the parameter. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - schema} | + * + * @property `schema` - Optional The schema defining the type used for the parameter + * + * @example { type: "string" } + * @example { type: "integer", minimum: 1, maximum: 100 } + */ + schema?: Schema; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - example} | - * - * @property `example` - Optional Example of the media type - * - * @example "example-value" - * @example 42 - */ - example?: unknown; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - example} | + * + * @property `example` - Optional Example of the media type + * + * @example "example-value" + * @example 42 + */ + example?: unknown; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - examples} | - * - * @property `examples` - Optional Examples of the media type - * - * @example { "user1": { summary: "A user example", value: "user123" } } - */ - examples?: Record; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - examples} | + * + * @property `examples` - Optional Examples of the media type + * + * @example { "user1": { summary: "A user example", value: "user123" } } + */ + examples?: Record; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - content} | - * - * @property `content` - Optional A map containing the representations for the parameter - * - * @example { "application/json": { schema: { type: "object" } } } - */ - content?: Record; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object | OpenAPI 3.2.0 Parameter Object - content} | + * + * @property `content` - Optional A map containing the representations for the parameter + * + * @example { "application/json": { schema: { type: "object" } } } + */ + content?: Record; } /** diff --git a/3.2/references.ts b/3.2/references.ts index 15cae52..f3244de 100644 --- a/3.2/references.ts +++ b/3.2/references.ts @@ -54,31 +54,31 @@ * ``` */ export interface Reference { - /** - * The reference string. This field is required and must be a valid JSON Reference. - * It can reference internal components using `#/` or external resources using URLs. - * - * @example "#/components/schemas/User" - * @example "#/components/responses/NotFound" - * @example "https://example.com/schemas/User.json" - */ - $ref: string; + /** + * The reference string. This field is required and must be a valid JSON Reference. + * It can reference internal components using `#/` or external resources using URLs. + * + * @example "#/components/schemas/User" + * @example "#/components/responses/NotFound" + * @example "https://example.com/schemas/User.json" + */ + $ref: string; - /** - * A description of the referenced object. This can be used to provide - * additional context about what the referenced object represents. - * - * @example "A user object containing user information" - * @example "Standard error response for not found resources" - */ - description?: string; + /** + * A description of the referenced object. This can be used to provide + * additional context about what the referenced object represents. + * + * @example "A user object containing user information" + * @example "Standard error response for not found resources" + */ + description?: string; - /** - * A short summary of the referenced object. This can be used to provide - * a brief overview of what the referenced object represents. - * - * @example "User schema" - * @example "Not found response" - */ - summary?: string; + /** + * A short summary of the referenced object. This can be used to provide + * a brief overview of what the referenced object represents. + * + * @example "User schema" + * @example "Not found response" + */ + summary?: string; } diff --git a/3.2/schema.ts b/3.2/schema.ts index 6c90bc8..bfeeba5 100644 --- a/3.2/schema.ts +++ b/3.2/schema.ts @@ -1,12 +1,12 @@ import type { - ArraySchema, - BooleanSchema, - CompositionSchema, - IntegerSchema, - NumberSchema, - ObjectSchema, - ReferenceSchema, - StringSchema, + ArraySchema, + BooleanSchema, + CompositionSchema, + IntegerSchema, + NumberSchema, + ObjectSchema, + ReferenceSchema, + StringSchema, } from "./data-types"; import type { Extension } from "./extensions"; @@ -56,21 +56,21 @@ import type { Extension } from "./extensions"; * ``` */ export interface Discriminator extends Extension { - /** - * The name of the property in the payload that will hold the discriminator value. - * This property must be present in the payload. - * - * Example: `"petType"` - */ - propertyName: string; + /** + * The name of the property in the payload that will hold the discriminator value. + * This property must be present in the payload. + * + * Example: `"petType"` + */ + propertyName: string; - /** - * An object to hold mappings between payload values and schema names or references. - * If not provided, the schema name will be used as the discriminator value. - * - * Example: `{ dog: "#/components/schemas/Dog", cat: "#/components/schemas/Cat" }` - */ - mapping?: Record; + /** + * An object to hold mappings between payload values and schema names or references. + * If not provided, the schema name will be used as the discriminator value. + * + * Example: `{ dog: "#/components/schemas/Dog", cat: "#/components/schemas/Cat" }` + */ + mapping?: Record; } /** @@ -228,11 +228,11 @@ export interface Discriminator extends Extension { * ``` */ export type Schema = - | ReferenceSchema - | StringSchema - | NumberSchema - | IntegerSchema - | BooleanSchema - | ArraySchema - | ObjectSchema - | CompositionSchema; + | ReferenceSchema + | StringSchema + | NumberSchema + | IntegerSchema + | BooleanSchema + | ArraySchema + | ObjectSchema + | CompositionSchema; diff --git a/3.2/servers.ts b/3.2/servers.ts index 465f2ef..6feaa14 100644 --- a/3.2/servers.ts +++ b/3.2/servers.ts @@ -56,49 +56,49 @@ import type { Extension } from "./extensions"; * ``` */ export interface Server extends Extension { - /** - * A URL to the target host. - * This URL supports Server Variables and MAY be relative, to indicate that the host - * location is relative to the location where the OpenAPI document is being served. - * Variable substitutions will be made when a variable is named in {brackets}. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object | OpenAPI 3.2.0 Server Object - url} | - * - * @property `url` - Required A URL to the target host - * - * @example "https://api.example.com/v1" - */ - url: string; + /** + * A URL to the target host. + * This URL supports Server Variables and MAY be relative, to indicate that the host + * location is relative to the location where the OpenAPI document is being served. + * Variable substitutions will be made when a variable is named in {brackets}. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object | OpenAPI 3.2.0 Server Object - url} | + * + * @property `url` - Required A URL to the target host + * + * @example "https://api.example.com/v1" + */ + url: string; - /** - * An optional string describing the host designated by the URL. - * CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object | OpenAPI 3.2.0 Server Object - description} | - * - * @property `description` - Optional An optional string describing the host designated by the URL - * - * @example "The production API server" - */ - description?: string; + /** + * An optional string describing the host designated by the URL. + * CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object | OpenAPI 3.2.0 Server Object - description} | + * + * @property `description` - Optional An optional string describing the host designated by the URL + * + * @example "The production API server" + */ + description?: string; - /** - * A map between a variable name and its value. - * The value is used for substitution in the server's URL template. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object | OpenAPI 3.2.0 Server Object - variables} | - * - * @property `variables` - Optional A map between a variable name and its value - * - * @example { username: { default: "demo" }, port: { default: "8443" } } - */ - variables?: Record; + /** + * A map between a variable name and its value. + * The value is used for substitution in the server's URL template. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object | OpenAPI 3.2.0 Server Object - variables} | + * + * @property `variables` - Optional A map between a variable name and its value + * + * @example { username: { default: "demo" }, port: { default: "8443" } } + */ + variables?: Record; } /** @@ -145,47 +145,47 @@ export interface Server extends Extension { * ``` */ export interface ServerVariable extends Extension { - /** - * An enumeration of string values to be used if the substitution options - * are from a limited set. The array SHOULD NOT be empty. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object | OpenAPI 3.2.0 Server Variable Object - enum} | - * - * @property `enum` - Optional An enumeration of string values to be used if the substitution options are from a limited set - * - * @example ["8443", "443"] - */ - enum?: string[]; + /** + * An enumeration of string values to be used if the substitution options + * are from a limited set. The array SHOULD NOT be empty. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object | OpenAPI 3.2.0 Server Variable Object - enum} | + * + * @property `enum` - Optional An enumeration of string values to be used if the substitution options are from a limited set + * + * @example ["8443", "443"] + */ + enum?: string[]; - /** - * The default value to use for substitution, which SHALL be sent if an - * alternate value is not supplied. Note this behavior is different than - * the Schema Object's treatment of default values, because in those cases - * parameter values are optional. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object | OpenAPI 3.2.0 Server Variable Object - default} | - * - * @property `default` - Required The default value to use for substitution - * - * @example "demo" - */ - default: string; + /** + * The default value to use for substitution, which SHALL be sent if an + * alternate value is not supplied. Note this behavior is different than + * the Schema Object's treatment of default values, because in those cases + * parameter values are optional. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object | OpenAPI 3.2.0 Server Variable Object - default} | + * + * @property `default` - Required The default value to use for substitution + * + * @example "demo" + */ + default: string; - /** - * An optional description for the server variable. - * CommonMark syntax MAY be used for rich text representation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object | OpenAPI 3.2.0 Server Variable Object - description} | - * - * @property `description` - Optional An optional description for the server variable - * - * @example "this value is assigned by the service provider" - */ - description?: string; + /** + * An optional description for the server variable. + * CommonMark syntax MAY be used for rich text representation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object | OpenAPI 3.2.0 Server Variable Object - description} | + * + * @property `description` - Optional An optional description for the server variable + * + * @example "this value is assigned by the service provider" + */ + description?: string; } diff --git a/3.2/spec.ts b/3.2/spec.ts index a2b4029..b30ee72 100644 --- a/3.2/spec.ts +++ b/3.2/spec.ts @@ -132,150 +132,150 @@ import type { Webhooks } from "./webhooks"; * ``` */ export interface Specification extends Extension { - /** - * This string MUST be the version number of the OpenAPI Specification that the - * OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret - * the OpenAPI document. This is not related to the API `info.version` string. - * This field is required. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - openapi} | - * - * @property `openapi` - Required The version number of the OpenAPI Specification - * - * @example "3.2.0" - */ - openapi: string; + /** + * This string MUST be the version number of the OpenAPI Specification that the + * OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret + * the OpenAPI document. This is not related to the API `info.version` string. + * This field is required. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - openapi} | + * + * @property `openapi` - Required The version number of the OpenAPI Specification + * + * @example "3.2.0" + */ + openapi: string; - /** - * Provides metadata about the API. The metadata MAY be used by tooling as required. - * This field is required. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - info} | - * - * @property `info` - Required Provides metadata about the API - * - * @example { title: "Pet Store API", version: "1.0.0" } - */ - info: Info; + /** + * Provides metadata about the API. The metadata MAY be used by tooling as required. + * This field is required. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - info} | + * + * @property `info` - Required Provides metadata about the API + * + * @example { title: "Pet Store API", version: "1.0.0" } + */ + info: Info; - /** - * The default value for the `$schema` keyword within Schema Objects contained - * within this OAS document. This MUST be in the form of a URI. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect} | - * - * @property `jsonSchemaDialect` - Optional The default value for the $schema keyword within Schema Objects - * - * @example "https://json-schema.org/draft/2020-12/schema" - */ - jsonSchemaDialect?: string; + /** + * The default value for the `$schema` keyword within Schema Objects contained + * within this OAS document. This MUST be in the form of a URI. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect} | + * + * @property `jsonSchemaDialect` - Optional The default value for the $schema keyword within Schema Objects + * + * @example "https://json-schema.org/draft/2020-12/schema" + */ + jsonSchemaDialect?: string; - /** - * An array of Server Objects, which provide connectivity information to a target - * server. If the `servers` property is not provided, or is an empty array, the - * default value would be a Server Object with a `url` value of `/`. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - servers} | - * - * @property `servers` - Optional An array of Server Objects - * - * @example [{ url: "https://api.example.com/v1", description: "The production API server" }] - */ - servers?: Server[]; + /** + * An array of Server Objects, which provide connectivity information to a target + * server. If the `servers` property is not provided, or is an empty array, the + * default value would be a Server Object with a `url` value of `/`. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - servers} | + * + * @property `servers` - Optional An array of Server Objects + * + * @example [{ url: "https://api.example.com/v1", description: "The production API server" }] + */ + servers?: Server[]; - /** - * The available paths and operations for the API. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - paths} | - * - * @property `paths` - Optional The available paths and operations for the API - * - * @example { "/pets": { "get": { "summary": "List all pets", "responses": { "200": { "description": "A list of pets" } } } } } - */ - paths?: Paths; + /** + * The available paths and operations for the API. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - paths} | + * + * @property `paths` - Optional The available paths and operations for the API + * + * @example { "/pets": { "get": { "summary": "List all pets", "responses": { "200": { "description": "A list of pets" } } } } } + */ + paths?: Paths; - /** - * The incoming webhooks that MAY be received as part of this API and that the - * API consumer MAY choose to implement. Closely related to the `callbacks` feature, - * this section describes requests initiated other than by an API call, for example - * by an out of band registration. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - webhooks} | - * - * @property `webhooks` - Optional The incoming webhooks that MAY be received as part of this API - * - * @example { "newPet": { "post": { "requestBody": { "description": "Information about a new pet" } } } } - */ - webhooks?: Webhooks; + /** + * The incoming webhooks that MAY be received as part of this API and that the + * API consumer MAY choose to implement. Closely related to the `callbacks` feature, + * this section describes requests initiated other than by an API call, for example + * by an out of band registration. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - webhooks} | + * + * @property `webhooks` - Optional The incoming webhooks that MAY be received as part of this API + * + * @example { "newPet": { "post": { "requestBody": { "description": "Information about a new pet" } } } } + */ + webhooks?: Webhooks; - /** - * An element to hold various schemas for the document. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - components} | - * - * @property `components` - Optional An element to hold various schemas for the document - * - * @example { schemas: { Pet: { type: "object", properties: { id: { type: "integer" } } } } } - */ - components?: Components; + /** + * An element to hold various schemas for the document. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - components} | + * + * @property `components` - Optional An element to hold various schemas for the document + * + * @example { schemas: { Pet: { type: "object", properties: { id: { type: "integer" } } } } } + */ + components?: Components; - /** - * 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - security} | - * - * @property `security` - Optional A declaration of which security mechanisms can be used across the API - * - * @example [{ "api_key": [] }] - */ - security?: SecurityRequirement[]; + /** + * 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - security} | + * + * @property `security` - Optional A declaration of which security mechanisms can be used across the API + * + * @example [{ "api_key": [] }] + */ + security?: SecurityRequirement[]; - /** - * A list of tags used by the document 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. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - tags} | - * - * @property `tags` - Optional A list of tags used by the document with additional metadata - * - * @example [{ name: "pets", description: "Pet store operations" }] - */ - tags?: Tag[]; + /** + * A list of tags used by the document 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. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - tags} | + * + * @property `tags` - Optional A list of tags used by the document with additional metadata + * + * @example [{ name: "pets", description: "Pet store operations" }] + */ + tags?: Tag[]; - /** - * Additional external documentation. - * - * | Version | Reference | - * |---|-----| - * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - externalDocs} | - * - * @property `externalDocs` - Optional Additional external documentation - * - * @example { description: "Find out more about our API", url: "https://example.com/docs" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation. + * + * | Version | Reference | + * |---|-----| + * | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object | OpenAPI 3.2.0 OpenAPI Object - externalDocs} | + * + * @property `externalDocs` - Optional Additional external documentation + * + * @example { description: "Find out more about our API", url: "https://example.com/docs" } + */ + externalDocs?: ExternalDocumentation; } diff --git a/3.2/status.ts b/3.2/status.ts index cbc0a2c..4301818 100644 --- a/3.2/status.ts +++ b/3.2/status.ts @@ -11,989 +11,989 @@ import type { Response } from "./components"; * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html | RFC 9110: HTTP Semantics} */ export interface ResponsesMap { - //#region Family Codes - - /** 1xx — Informational - * - * Indicates that the request was received and the server is continuing to process it. - * - * Used for provisional responses that indicate the server has received the request and is continuing to process it. These responses are typically used for status updates during long-running operations or to indicate that the server is ready to receive additional data. - * - * The client should continue waiting for the final response. These are provisional responses and the client should not consider the request complete until receiving a final status code. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "1xx"?: Response; - - /** 2xx — Success - * - * Indicates that the request was successfully received, understood, and accepted. - * - * Used for successful operations where the request was processed successfully and the response contains the requested data or indicates successful completion of the operation. - * - * The operation completed successfully. The response body typically contains the requested data or confirmation of the successful operation. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "2xx"?: Response; - - /** 3xx — Redirection - * - * Indicates that further action needs to be taken by the client to complete the request. - * - * Used when the client needs to take additional action to complete the request, such as following a redirect, providing authentication, or accessing the resource at a different location. - * - * The client needs to take additional action to complete the request. This may involve following a redirect, providing authentication, or accessing the resource at a different location. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "3xx"?: Response; - - /** 4xx — Client Error - * - * Indicates that the request contains bad syntax or cannot be fulfilled by the server. - * - * Used when the client has sent an invalid request, such as malformed syntax, invalid parameters, authentication failures, or requests for non-existent resources. - * - * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "4xx"?: Response; - - /** 5xx — Server Error - * - * Indicates that the server failed to fulfill a valid request. - * - * Used when the server encounters an error while processing a valid request, such as internal server errors, service unavailability, or gateway timeouts. - * - * The server encountered an error while processing the request. The client should retry the request later, as this is typically a temporary issue. - * - * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} - */ - "5xx"?: Response; - - //#endregion - - //#region 1xx — Informational - - /** 100 Continue - * - * Indicates that the initial part of the request has been received and the client should continue with the request. - * - * The server has received the request headers and the client should proceed to send the request body. - * - * Used in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns. - * - * The server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue | RFC 9110 §15.2.1} - */ - "100"?: Response; - - /** 101 Switching Protocols - * - * Indicates that the server is switching protocols as requested by the client. - * - * The server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols. - * - * Primarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios. - * - * The connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols | RFC 9110 §15.2.2} - */ - "101"?: Response; - - /** 102 Processing - * - * Indicates that the server has received and is processing the request, but no response is available yet. - * - * The server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting. - * - * Primarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods. - * - * The request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2518 | RFC 2518 (WebDAV)} - */ - "102"?: Response; - - /** 103 Early Hints - * - * Provides early hints about the response that will be sent, allowing the client to start processing before the full response is ready. - * - * The server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early. - * - * Used for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance. - * - * The client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc8297 | RFC 8297} - */ - "103"?: Response; - - /** 104 Upload Resumption Supported — TEMPORARY - * - * Indicates that the server supports resumable uploads for the requested resource. - * - * The server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off. - * - * Used in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste. - * - * The client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions. - * - * @note Temporary registration; see IANA entry for current status/expiry. - * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05 | draft-ietf-httpbis-resumable-upload-05} - * @see {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | IANA registry} - */ - "104"?: Response; - - //#endregion - - //#region 2xx — Success - - /** 200 OK - * - * Indicates that the request has succeeded and the response contains the requested data. - * - * The request was processed successfully and the response body contains the requested resource or data. - * - * The most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return. - * - * The operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok | RFC 9110 §15.3.1} - */ - "200"?: Response; - - /** 201 Created - * - * Indicates that the request has succeeded and a new resource has been created as a result. - * - * The request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource. - * - * Used for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations. - * - * A new resource was successfully created and the response contains information about the created resource, typically including its ID and location. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created | RFC 9110 §15.3.2} - */ - "201"?: Response; - - /** 202 Accepted - * - * Indicates that the request has been accepted for processing, but the processing has not been completed. - * - * The request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed. - * - * Used for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone. - * - * The request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted | RFC 9110 §15.3.3} - */ - "202"?: Response; - - /** 203 Non-Authoritative Information - * - * Indicates that the request was successful, but the information returned is from a transformed or cached version of the original resource. - * - * The response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version. - * - * Used when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware. - * - * The request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-informat | RFC 9110 §15.3.4} - */ - "203"?: Response; - - /** 204 No Content - * - * Indicates that the request has succeeded but there is no content to return in the response body. - * - * The request was processed successfully but the response body is intentionally empty. The client should not expect any content. - * - * Used for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data. - * - * The operation completed successfully but no data is returned. The client should not attempt to parse a response body. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content | RFC 9110 §15.3.5} - */ - "204"?: Response; - - /** 205 Reset Content - * - * Indicates that the request has succeeded and the client should reset the document view that caused the request to be sent. - * - * The request was processed successfully and the client should clear any form data or reset the user interface state. - * - * Used in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations. - * - * The operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content | RFC 9110 §15.3.6} - */ - "205"?: Response; - - /** 206 Partial Content - * - * Indicates that the server is delivering only part of the resource due to a range request. - * - * The request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered. - * - * Used for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads. - * - * The response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content | RFC 9110 §15.3.7} - */ - "206"?: Response; - - /** 207 Multi-Status - * - * Indicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body. - * - * The response contains multiple status codes for different operations, typically in XML format with individual operation results. - * - * Used in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms. - * - * Multiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "207"?: Response; - - /** 208 Already Reported - * - * Indicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again. - * - * Used in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported. - * - * Used in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations. - * - * The information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} - */ - "208"?: Response; - - /** 226 IM Used - * - * Indicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. - * - * The response represents the result of applying instance manipulations (like delta encoding) to the current resource instance. - * - * Used in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission. - * - * The response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc3229 | RFC 3229} - */ - "226"?: Response; - - //#endregion - - //#region 3xx — Redirection - - /** 300 Multiple Choices - * - * Indicates that the request has multiple possible responses and the client should choose one. - * - * The server has multiple representations of the requested resource and the client must choose which one to use. - * - * Used when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics. - * - * The client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices | RFC 9110 §15.4.1} - */ - "300"?: Response; - - /** 301 Moved Permanently - * - * Indicates that the requested resource has been permanently moved to a new location. - * - * The resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header. - * - * Used when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches. - * - * The resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently | RFC 9110 §15.4.2} - */ - "301"?: Response; - - /** 302 Found - * - * Indicates that the requested resource has been temporarily moved to a different location. - * - * The resource is temporarily available at a different URL, but the original URL should continue to be used for future requests. - * - * Used for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid. - * - * The resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found | RFC 9110 §15.4.3} - */ - "302"?: Response; - - /** 303 See Other - * - * Indicates that the response to the request can be found at a different URL and should be retrieved using a GET request. - * - * The request was processed but the response is available at a different location, and the client should use GET to retrieve it. - * - * Used in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions. - * - * The client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other | RFC 9110 §15.4.4} - */ - "303"?: Response; - - /** 304 Not Modified - * - * Indicates that the resource has not been modified since the last request, so the cached version can be used. - * - * The resource has not changed since the last request, and the client can use its cached version. No response body is included. - * - * Used for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer. - * - * The resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified | RFC 9110 §15.4.5} - */ - "304"?: Response; - - /** 305 Use Proxy - * - * Indicates that the requested resource must be accessed through the proxy specified in the Location header. - * - * The client must use the specified proxy to access the resource. This response is rarely used in modern web applications. - * - * Used in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development. - * - * The client should use the specified proxy to access the resource. This is rarely encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy | RFC 9110 §15.4.6} - */ - "305"?: Response; - - /** 306 (Unused) - * - * This status code is reserved and not used in current HTTP specifications. - * - * This status code was previously used but is now reserved and should not be used in new implementations. - * - * Not used in modern web applications. This code is reserved and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-306-unused | RFC 9110 §15.4.7} - */ - "306"?: Response; - - /** 307 Temporary Redirect - * - * Indicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved. - * - * The resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location. - * - * Used for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated. - * - * The resource is temporarily at a different location and the client should repeat the same request method to the new URL. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect | RFC 9110 §15.4.8} - */ - "307"?: Response; - - /** 308 Permanent Redirect - * - * Indicates that the requested resource has been permanently moved to a different location, and the request method should be preserved. - * - * The resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method. - * - * Used for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations. - * - * The resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect | RFC 9110 §15.4.9} - */ - "308"?: Response; - - //#endregion - - //#region 4xx — Client Error - - /** 400 Bad Request - * - * Indicates that the server cannot process the request due to a client error. - * - * The request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process. - * - * Used for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios. - * - * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request | RFC 9110 §15.5.1} - */ - "400"?: Response; - - /** 401 Unauthorized - * - * Indicates that the request requires authentication and the client has not provided valid credentials. - * - * The request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient. - * - * Used when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows. - * - * The client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized | RFC 9110 §15.5.2} - */ - "401"?: Response; - - /** 402 Payment Required - * - * Indicates that the request requires payment before it can be processed. - * - * The request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems. - * - * Used in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services. - * - * The client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required | RFC 9110 §15.5.3} - */ - "402"?: Response; - - /** 403 Forbidden - * - * Indicates that the server understood the request but refuses to authorize it. - * - * The client is authenticated but does not have permission to access the requested resource or perform the requested action. - * - * Used when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios. - * - * The client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden | RFC 9110 §15.5.4} - */ - "403"?: Response; - - /** 404 Not Found - * - * Indicates that the requested resource could not be found on the server. - * - * The server cannot find the requested resource at the specified URL, or the resource does not exist. - * - * Used when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints. - * - * The requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found | RFC 9110 §15.5.5} - */ - "404"?: Response; - - /** 405 Method Not Allowed - * - * Indicates that the HTTP method used in the request is not allowed for the requested resource. - * - * The resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource. - * - * Used when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design. - * - * The HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed | RFC 9110 §15.5.6} - */ - "405"?: Response; - - /** 406 Not Acceptable - * - * Indicates that the server cannot produce a response matching the client's Accept headers. - * - * The server cannot generate a response in any of the formats requested by the client's Accept headers. - * - * Used when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches. - * - * The server cannot provide the requested content type. The client should check the Accept headers or request a different format. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable | RFC 9110 §15.5.7} - */ - "406"?: Response; - - /** 407 Proxy Authentication Required - * - * Indicates that the client must authenticate with the proxy server before the request can be processed. - * - * The proxy server requires authentication before it will forward the request to the destination server. - * - * Used in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies. - * - * The client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-req | RFC 9110 §15.5.8} - */ - "407"?: Response; - - /** 408 Request Timeout - * - * Indicates that the server timed out while waiting for the request from the client. - * - * The server did not receive a complete request within the time it was prepared to wait. - * - * Used when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests. - * - * The request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout | RFC 9110 §15.5.9} - */ - "408"?: Response; - - /** 409 Conflict - * - * Indicates that the request conflicts with the current state of the resource. - * - * The request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification. - * - * Used when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios. - * - * The request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | RFC 9110 §15.5.10} - */ - "409"?: Response; - - /** 410 Gone - * - * Indicates that the requested resource is no longer available and will not be available again. - * - * The resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found. - * - * Used when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios. - * - * The resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone | RFC 9110 §15.5.11} - */ - "410"?: Response; - - /** 411 Length Required - * - * Indicates that the server requires a Content-Length header in the request. - * - * The server cannot process the request without knowing the exact length of the request body. - * - * Used when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints. - * - * The client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required | RFC 9110 §15.5.12} - */ - "411"?: Response; - - /** 412 Precondition Failed - * - * Indicates that one or more preconditions in the request headers were not met. - * - * The server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since. - * - * Used in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios. - * - * The preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed | RFC 9110 §15.5.13} - */ - "412"?: Response; - - /** 413 Content Too Large - * - * Indicates that the request payload is too large for the server to process. - * - * The request body exceeds the server's maximum allowed size limit. - * - * Used when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting. - * - * The request payload is too large. The client should reduce the size of the request body or split it into smaller chunks. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large | RFC 9110 §15.5.14} - */ - "413"?: Response; - - /** 414 URI Too Long - * - * Indicates that the URI provided in the request is too long for the server to process. - * - * The URL exceeds the server's maximum allowed length limit. - * - * Used when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests. - * - * The URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long | RFC 9110 §15.5.15} - */ - "414"?: Response; - - /** 415 Unsupported Media Type - * - * Indicates that the server cannot process the request because the media type is not supported. - * - * The server cannot process the request body because the Content-Type is not supported or recognized. - * - * Used when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements. - * - * The content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type | RFC 9110 §15.5.16} - */ - "415"?: Response; - - /** 416 Range Not Satisfiable - * - * Indicates that the server cannot satisfy the range request specified in the Range header. - * - * The requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests. - * - * Used when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming. - * - * The range request is not satisfiable. The client should check the range specification or request the full resource. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable | RFC 9110 §15.5.17} - */ - "416"?: Response; - - /** 417 Expectation Failed - * - * Indicates that the server cannot meet the requirements of the Expect header. - * - * The server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation. - * - * Used when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations. - * - * The server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed | RFC 9110 §15.5.18} - */ - "417"?: Response; - - /** 418 (Unused) - * - * This status code is reserved and not used in current HTTP specifications. - * - * This status code is reserved and should not be used in new implementations. - * - * Not used in modern web applications. This code is reserved and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-418-unused | RFC 9110 §15.5.19} - */ - "418"?: Response; - - /** 421 Misdirected Request - * - * Indicates that the request was directed to a server that is not able to produce a response. - * - * The request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems. - * - * Used in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios. - * - * The request was sent to the wrong server. The client should retry the request, which may be routed to a different server. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request | RFC 9110 §15.5.20} - */ - "421"?: Response; - - /** 422 Unprocessable Content - * - * Indicates that the request is well-formed but contains semantic errors that prevent processing. - * - * The request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations. - * - * Used for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid. - * - * The request is well-formed but contains semantic errors. The client should fix the data and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content | RFC 9110 §15.5.21} - */ - "422"?: Response; - - /** 423 Locked - * - * Indicates that the requested resource is locked and cannot be modified. - * - * The resource is locked by another process or user and cannot be accessed or modified at this time. - * - * Used in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms. - * - * The resource is locked and cannot be accessed. The client should wait and retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "423"?: Response; - - /** 424 Failed Dependency - * - * Indicates that the request failed because it depended on another request that also failed. - * - * The request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations. - * - * Used in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios. - * - * The request failed due to a dependency failure. The client should check the dependencies and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "424"?: Response; - - /** 425 Too Early - * - * Indicates that the server is unwilling to process the request because it might be replayed. - * - * The server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns. - * - * Used in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols. - * - * The server is unwilling to process the request due to replay concerns. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc8470 | RFC 8470} - */ - "425"?: Response; - - /** 426 Upgrade Required - * - * Indicates that the server requires the client to upgrade to a different protocol. - * - * The server requires the client to use a different protocol version or upgrade to a newer version to access the resource. - * - * Used when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios. - * - * The client must upgrade to a different protocol version. The response should include upgrade information. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required | RFC 9110 §15.5.22} - */ - "426"?: Response; - - /** 428 Precondition Required - * - * Indicates that the server requires the request to include certain preconditions. - * - * The server requires the client to include specific preconditions in the request headers before it will process the request. - * - * Used when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios. - * - * The server requires specific preconditions. The client should include the required preconditions and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "428"?: Response; - - /** 429 Too Many Requests - * - * Indicates that the client has sent too many requests in a given time period and should slow down. - * - * The client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets. - * - * Used for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers. - * - * The client has exceeded the rate limit and should slow down. The client should wait before retrying the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "429"?: Response; - - /** 431 Request Header Fields Too Large - * - * Indicates that the server is unwilling to process the request because the header fields are too large. - * - * The request headers exceed the server's maximum allowed size limit. - * - * Used when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data. - * - * The request headers are too large. The client should reduce the size of the headers and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "431"?: Response; - - /** 451 Unavailable For Legal Reasons - * - * Indicates that the requested resource is unavailable due to legal reasons. - * - * The resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements. - * - * Used when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services. - * - * The resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc7725 | RFC 7725} - */ - "451"?: Response; - - //#endregion - - //#region 5xx — Server Error - - /** 500 Internal Server Error - * - * Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. - * - * The server encountered an internal error or exception that prevented it from processing the request successfully. - * - * Used for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems. - * - * The server encountered an internal error. The client should retry the request later, as this is typically a temporary issue. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error | RFC 9110 §15.6.1} - */ - "500"?: Response; - - /** 501 Not Implemented - * - * Indicates that the server does not support the functionality required to fulfill the request. - * - * The server does not recognize the request method or lacks the ability to fulfill the request. - * - * Used when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented. - * - * The server does not support the requested functionality. The client should check the API documentation for supported methods and features. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented | RFC 9110 §15.6.2} - */ - "501"?: Response; - - /** 502 Bad Gateway - * - * Indicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server. - * - * The server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access. - * - * Used in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems. - * - * The gateway received an invalid response from the upstream server. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway | RFC 9110 §15.6.3} - */ - "502"?: Response; - - /** 503 Service Unavailable - * - * Indicates that the server is temporarily unable to handle the request due to maintenance or overload. - * - * The server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints. - * - * Used during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows. - * - * The server is temporarily unavailable. The client should retry the request later, often with exponential backoff. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable | RFC 9110 §15.6.4} - */ - "503"?: Response; - - /** 504 Gateway Timeout - * - * Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server. - * - * The gateway or proxy server timed out while waiting for a response from the upstream server. - * - * Used in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times. - * - * The gateway timed out waiting for the upstream server. The client should retry the request later. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout | RFC 9110 §15.6.5} - */ - "504"?: Response; - - /** 505 HTTP Version Not Supported - * - * Indicates that the server does not support the HTTP protocol version used in the request. - * - * The server does not support the HTTP protocol version specified in the request. - * - * Used when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios. - * - * The server does not support the HTTP version used in the request. The client should use a supported HTTP version. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-supporte | RFC 9110 §15.6.6} - */ - "505"?: Response; - - /** 506 Variant Also Negotiates - * - * Indicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation. - * - * The server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop. - * - * Used in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations. - * - * The server has a configuration error in content negotiation. The client should contact the server administrator. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2295 | RFC 2295} - */ - "506"?: Response; - - /** 507 Insufficient Storage - * - * Indicates that the server is unable to store the representation needed to complete the request. - * - * The server cannot store the representation required to complete the request, typically due to storage space limitations. - * - * Used in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms. - * - * The server cannot store the required representation. The client should check storage availability and retry the request. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} - */ - "507"?: Response; - - /** 508 Loop Detected - * - * Indicates that the server detected an infinite loop while processing the request. - * - * The server detected an infinite loop in the request processing, typically in WebDAV operations. - * - * Used in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios. - * - * The server detected an infinite loop. The client should check the request for circular references and retry. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} - */ - "508"?: Response; - - /** 510 Not Extended — OBSOLETED - * - * This status code is obsolete and should not be used in modern implementations. - * - * This status code was used for HTTP extensions but is now obsolete and should not be used. - * - * Not used in modern web applications. This code is obsolete and should not be implemented. - * - * This status code should not be encountered in modern web applications. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc2774 | RFC 2774 (Historic)} - * @see {@link https://datatracker.ietf.org/doc/status-change-http-experiments-to-historic/ | IETF: Status change of HTTP experiments to Historic} - */ - "510"?: Response; - - /** 511 Network Authentication Required - * - * Indicates that the client needs to authenticate to gain network access. - * - * The client must authenticate with the network before it can access the requested resource. - * - * Used in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication. - * - * The client needs to authenticate with the network. The client should follow the authentication process provided by the network. - * - * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} - */ - "511"?: Response; - - //#endregion - - /** default — The default response for all codes not covered individually. */ - default?: Response; + //#region Family Codes + + /** 1xx — Informational + * + * Indicates that the request was received and the server is continuing to process it. + * + * Used for provisional responses that indicate the server has received the request and is continuing to process it. These responses are typically used for status updates during long-running operations or to indicate that the server is ready to receive additional data. + * + * The client should continue waiting for the final response. These are provisional responses and the client should not consider the request complete until receiving a final status code. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "1xx"?: Response; + + /** 2xx — Success + * + * Indicates that the request was successfully received, understood, and accepted. + * + * Used for successful operations where the request was processed successfully and the response contains the requested data or indicates successful completion of the operation. + * + * The operation completed successfully. The response body typically contains the requested data or confirmation of the successful operation. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "2xx"?: Response; + + /** 3xx — Redirection + * + * Indicates that further action needs to be taken by the client to complete the request. + * + * Used when the client needs to take additional action to complete the request, such as following a redirect, providing authentication, or accessing the resource at a different location. + * + * The client needs to take additional action to complete the request. This may involve following a redirect, providing authentication, or accessing the resource at a different location. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "3xx"?: Response; + + /** 4xx — Client Error + * + * Indicates that the request contains bad syntax or cannot be fulfilled by the server. + * + * Used when the client has sent an invalid request, such as malformed syntax, invalid parameters, authentication failures, or requests for non-existent resources. + * + * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "4xx"?: Response; + + /** 5xx — Server Error + * + * Indicates that the server failed to fulfill a valid request. + * + * Used when the server encounters an error while processing a valid request, such as internal server errors, service unavailability, or gateway timeouts. + * + * The server encountered an error while processing the request. The client should retry the request later, as this is typically a temporary issue. + * + * @see {@link https://spec.openapis.org/oas/v3.0.3#responses-object | OpenAPI 3.0.3 Responses Object} + */ + "5xx"?: Response; + + //#endregion + + //#region 1xx — Informational + + /** 100 Continue + * + * Indicates that the initial part of the request has been received and the client should continue with the request. + * + * The server has received the request headers and the client should proceed to send the request body. + * + * Used in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns. + * + * The server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-100-continue | RFC 9110 §15.2.1} + */ + "100"?: Response; + + /** 101 Switching Protocols + * + * Indicates that the server is switching protocols as requested by the client. + * + * The server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols. + * + * Primarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios. + * + * The connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-101-switching-protocols | RFC 9110 §15.2.2} + */ + "101"?: Response; + + /** 102 Processing + * + * Indicates that the server has received and is processing the request, but no response is available yet. + * + * The server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting. + * + * Primarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods. + * + * The request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2518 | RFC 2518 (WebDAV)} + */ + "102"?: Response; + + /** 103 Early Hints + * + * Provides early hints about the response that will be sent, allowing the client to start processing before the full response is ready. + * + * The server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early. + * + * Used for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance. + * + * The client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc8297 | RFC 8297} + */ + "103"?: Response; + + /** 104 Upload Resumption Supported — TEMPORARY + * + * Indicates that the server supports resumable uploads for the requested resource. + * + * The server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off. + * + * Used in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste. + * + * The client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions. + * + * @note Temporary registration; see IANA entry for current status/expiry. + * @see {@link https://datatracker.ietf.org/doc/html/draft-ietf-httpbis-resumable-upload-05 | draft-ietf-httpbis-resumable-upload-05} + * @see {@link https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml | IANA registry} + */ + "104"?: Response; + + //#endregion + + //#region 2xx — Success + + /** 200 OK + * + * Indicates that the request has succeeded and the response contains the requested data. + * + * The request was processed successfully and the response body contains the requested resource or data. + * + * The most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return. + * + * The operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-200-ok | RFC 9110 §15.3.1} + */ + "200"?: Response; + + /** 201 Created + * + * Indicates that the request has succeeded and a new resource has been created as a result. + * + * The request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource. + * + * Used for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations. + * + * A new resource was successfully created and the response contains information about the created resource, typically including its ID and location. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-201-created | RFC 9110 §15.3.2} + */ + "201"?: Response; + + /** 202 Accepted + * + * Indicates that the request has been accepted for processing, but the processing has not been completed. + * + * The request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed. + * + * Used for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone. + * + * The request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-202-accepted | RFC 9110 §15.3.3} + */ + "202"?: Response; + + /** 203 Non-Authoritative Information + * + * Indicates that the request was successful, but the information returned is from a transformed or cached version of the original resource. + * + * The response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version. + * + * Used when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware. + * + * The request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-203-non-authoritative-informat | RFC 9110 §15.3.4} + */ + "203"?: Response; + + /** 204 No Content + * + * Indicates that the request has succeeded but there is no content to return in the response body. + * + * The request was processed successfully but the response body is intentionally empty. The client should not expect any content. + * + * Used for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data. + * + * The operation completed successfully but no data is returned. The client should not attempt to parse a response body. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-204-no-content | RFC 9110 §15.3.5} + */ + "204"?: Response; + + /** 205 Reset Content + * + * Indicates that the request has succeeded and the client should reset the document view that caused the request to be sent. + * + * The request was processed successfully and the client should clear any form data or reset the user interface state. + * + * Used in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations. + * + * The operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-205-reset-content | RFC 9110 §15.3.6} + */ + "205"?: Response; + + /** 206 Partial Content + * + * Indicates that the server is delivering only part of the resource due to a range request. + * + * The request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered. + * + * Used for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads. + * + * The response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-206-partial-content | RFC 9110 §15.3.7} + */ + "206"?: Response; + + /** 207 Multi-Status + * + * Indicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body. + * + * The response contains multiple status codes for different operations, typically in XML format with individual operation results. + * + * Used in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms. + * + * Multiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "207"?: Response; + + /** 208 Already Reported + * + * Indicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again. + * + * Used in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported. + * + * Used in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations. + * + * The information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} + */ + "208"?: Response; + + /** 226 IM Used + * + * Indicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. + * + * The response represents the result of applying instance manipulations (like delta encoding) to the current resource instance. + * + * Used in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission. + * + * The response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc3229 | RFC 3229} + */ + "226"?: Response; + + //#endregion + + //#region 3xx — Redirection + + /** 300 Multiple Choices + * + * Indicates that the request has multiple possible responses and the client should choose one. + * + * The server has multiple representations of the requested resource and the client must choose which one to use. + * + * Used when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics. + * + * The client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-300-multiple-choices | RFC 9110 §15.4.1} + */ + "300"?: Response; + + /** 301 Moved Permanently + * + * Indicates that the requested resource has been permanently moved to a new location. + * + * The resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header. + * + * Used when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches. + * + * The resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-301-moved-permanently | RFC 9110 §15.4.2} + */ + "301"?: Response; + + /** 302 Found + * + * Indicates that the requested resource has been temporarily moved to a different location. + * + * The resource is temporarily available at a different URL, but the original URL should continue to be used for future requests. + * + * Used for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid. + * + * The resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-302-found | RFC 9110 §15.4.3} + */ + "302"?: Response; + + /** 303 See Other + * + * Indicates that the response to the request can be found at a different URL and should be retrieved using a GET request. + * + * The request was processed but the response is available at a different location, and the client should use GET to retrieve it. + * + * Used in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions. + * + * The client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-303-see-other | RFC 9110 §15.4.4} + */ + "303"?: Response; + + /** 304 Not Modified + * + * Indicates that the resource has not been modified since the last request, so the cached version can be used. + * + * The resource has not changed since the last request, and the client can use its cached version. No response body is included. + * + * Used for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer. + * + * The resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-304-not-modified | RFC 9110 §15.4.5} + */ + "304"?: Response; + + /** 305 Use Proxy + * + * Indicates that the requested resource must be accessed through the proxy specified in the Location header. + * + * The client must use the specified proxy to access the resource. This response is rarely used in modern web applications. + * + * Used in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development. + * + * The client should use the specified proxy to access the resource. This is rarely encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-305-use-proxy | RFC 9110 §15.4.6} + */ + "305"?: Response; + + /** 306 (Unused) + * + * This status code is reserved and not used in current HTTP specifications. + * + * This status code was previously used but is now reserved and should not be used in new implementations. + * + * Not used in modern web applications. This code is reserved and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-306-unused | RFC 9110 §15.4.7} + */ + "306"?: Response; + + /** 307 Temporary Redirect + * + * Indicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved. + * + * The resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location. + * + * Used for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated. + * + * The resource is temporarily at a different location and the client should repeat the same request method to the new URL. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-307-temporary-redirect | RFC 9110 §15.4.8} + */ + "307"?: Response; + + /** 308 Permanent Redirect + * + * Indicates that the requested resource has been permanently moved to a different location, and the request method should be preserved. + * + * The resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method. + * + * Used for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations. + * + * The resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-308-permanent-redirect | RFC 9110 §15.4.9} + */ + "308"?: Response; + + //#endregion + + //#region 4xx — Client Error + + /** 400 Bad Request + * + * Indicates that the server cannot process the request due to a client error. + * + * The request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process. + * + * Used for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios. + * + * The client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-400-bad-request | RFC 9110 §15.5.1} + */ + "400"?: Response; + + /** 401 Unauthorized + * + * Indicates that the request requires authentication and the client has not provided valid credentials. + * + * The request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient. + * + * Used when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows. + * + * The client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-401-unauthorized | RFC 9110 §15.5.2} + */ + "401"?: Response; + + /** 402 Payment Required + * + * Indicates that the request requires payment before it can be processed. + * + * The request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems. + * + * Used in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services. + * + * The client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-402-payment-required | RFC 9110 §15.5.3} + */ + "402"?: Response; + + /** 403 Forbidden + * + * Indicates that the server understood the request but refuses to authorize it. + * + * The client is authenticated but does not have permission to access the requested resource or perform the requested action. + * + * Used when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios. + * + * The client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-403-forbidden | RFC 9110 §15.5.4} + */ + "403"?: Response; + + /** 404 Not Found + * + * Indicates that the requested resource could not be found on the server. + * + * The server cannot find the requested resource at the specified URL, or the resource does not exist. + * + * Used when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints. + * + * The requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-404-not-found | RFC 9110 §15.5.5} + */ + "404"?: Response; + + /** 405 Method Not Allowed + * + * Indicates that the HTTP method used in the request is not allowed for the requested resource. + * + * The resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource. + * + * Used when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design. + * + * The HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-405-method-not-allowed | RFC 9110 §15.5.6} + */ + "405"?: Response; + + /** 406 Not Acceptable + * + * Indicates that the server cannot produce a response matching the client's Accept headers. + * + * The server cannot generate a response in any of the formats requested by the client's Accept headers. + * + * Used when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches. + * + * The server cannot provide the requested content type. The client should check the Accept headers or request a different format. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-406-not-acceptable | RFC 9110 §15.5.7} + */ + "406"?: Response; + + /** 407 Proxy Authentication Required + * + * Indicates that the client must authenticate with the proxy server before the request can be processed. + * + * The proxy server requires authentication before it will forward the request to the destination server. + * + * Used in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies. + * + * The client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-407-proxy-authentication-req | RFC 9110 §15.5.8} + */ + "407"?: Response; + + /** 408 Request Timeout + * + * Indicates that the server timed out while waiting for the request from the client. + * + * The server did not receive a complete request within the time it was prepared to wait. + * + * Used when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests. + * + * The request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-408-request-timeout | RFC 9110 §15.5.9} + */ + "408"?: Response; + + /** 409 Conflict + * + * Indicates that the request conflicts with the current state of the resource. + * + * The request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification. + * + * Used when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios. + * + * The request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-409-conflict | RFC 9110 §15.5.10} + */ + "409"?: Response; + + /** 410 Gone + * + * Indicates that the requested resource is no longer available and will not be available again. + * + * The resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found. + * + * Used when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios. + * + * The resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-410-gone | RFC 9110 §15.5.11} + */ + "410"?: Response; + + /** 411 Length Required + * + * Indicates that the server requires a Content-Length header in the request. + * + * The server cannot process the request without knowing the exact length of the request body. + * + * Used when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints. + * + * The client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-411-length-required | RFC 9110 §15.5.12} + */ + "411"?: Response; + + /** 412 Precondition Failed + * + * Indicates that one or more preconditions in the request headers were not met. + * + * The server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since. + * + * Used in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios. + * + * The preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-412-precondition-failed | RFC 9110 §15.5.13} + */ + "412"?: Response; + + /** 413 Content Too Large + * + * Indicates that the request payload is too large for the server to process. + * + * The request body exceeds the server's maximum allowed size limit. + * + * Used when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting. + * + * The request payload is too large. The client should reduce the size of the request body or split it into smaller chunks. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-413-content-too-large | RFC 9110 §15.5.14} + */ + "413"?: Response; + + /** 414 URI Too Long + * + * Indicates that the URI provided in the request is too long for the server to process. + * + * The URL exceeds the server's maximum allowed length limit. + * + * Used when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests. + * + * The URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-414-uri-too-long | RFC 9110 §15.5.15} + */ + "414"?: Response; + + /** 415 Unsupported Media Type + * + * Indicates that the server cannot process the request because the media type is not supported. + * + * The server cannot process the request body because the Content-Type is not supported or recognized. + * + * Used when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements. + * + * The content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-415-unsupported-media-type | RFC 9110 §15.5.16} + */ + "415"?: Response; + + /** 416 Range Not Satisfiable + * + * Indicates that the server cannot satisfy the range request specified in the Range header. + * + * The requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests. + * + * Used when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming. + * + * The range request is not satisfiable. The client should check the range specification or request the full resource. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-416-range-not-satisfiable | RFC 9110 §15.5.17} + */ + "416"?: Response; + + /** 417 Expectation Failed + * + * Indicates that the server cannot meet the requirements of the Expect header. + * + * The server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation. + * + * Used when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations. + * + * The server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-417-expectation-failed | RFC 9110 §15.5.18} + */ + "417"?: Response; + + /** 418 (Unused) + * + * This status code is reserved and not used in current HTTP specifications. + * + * This status code is reserved and should not be used in new implementations. + * + * Not used in modern web applications. This code is reserved and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-418-unused | RFC 9110 §15.5.19} + */ + "418"?: Response; + + /** 421 Misdirected Request + * + * Indicates that the request was directed to a server that is not able to produce a response. + * + * The request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems. + * + * Used in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios. + * + * The request was sent to the wrong server. The client should retry the request, which may be routed to a different server. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-421-misdirected-request | RFC 9110 §15.5.20} + */ + "421"?: Response; + + /** 422 Unprocessable Content + * + * Indicates that the request is well-formed but contains semantic errors that prevent processing. + * + * The request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations. + * + * Used for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid. + * + * The request is well-formed but contains semantic errors. The client should fix the data and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-422-unprocessable-content | RFC 9110 §15.5.21} + */ + "422"?: Response; + + /** 423 Locked + * + * Indicates that the requested resource is locked and cannot be modified. + * + * The resource is locked by another process or user and cannot be accessed or modified at this time. + * + * Used in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms. + * + * The resource is locked and cannot be accessed. The client should wait and retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "423"?: Response; + + /** 424 Failed Dependency + * + * Indicates that the request failed because it depended on another request that also failed. + * + * The request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations. + * + * Used in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios. + * + * The request failed due to a dependency failure. The client should check the dependencies and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "424"?: Response; + + /** 425 Too Early + * + * Indicates that the server is unwilling to process the request because it might be replayed. + * + * The server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns. + * + * Used in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols. + * + * The server is unwilling to process the request due to replay concerns. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc8470 | RFC 8470} + */ + "425"?: Response; + + /** 426 Upgrade Required + * + * Indicates that the server requires the client to upgrade to a different protocol. + * + * The server requires the client to use a different protocol version or upgrade to a newer version to access the resource. + * + * Used when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios. + * + * The client must upgrade to a different protocol version. The response should include upgrade information. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-426-upgrade-required | RFC 9110 §15.5.22} + */ + "426"?: Response; + + /** 428 Precondition Required + * + * Indicates that the server requires the request to include certain preconditions. + * + * The server requires the client to include specific preconditions in the request headers before it will process the request. + * + * Used when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios. + * + * The server requires specific preconditions. The client should include the required preconditions and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "428"?: Response; + + /** 429 Too Many Requests + * + * Indicates that the client has sent too many requests in a given time period and should slow down. + * + * The client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets. + * + * Used for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers. + * + * The client has exceeded the rate limit and should slow down. The client should wait before retrying the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "429"?: Response; + + /** 431 Request Header Fields Too Large + * + * Indicates that the server is unwilling to process the request because the header fields are too large. + * + * The request headers exceed the server's maximum allowed size limit. + * + * Used when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data. + * + * The request headers are too large. The client should reduce the size of the headers and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "431"?: Response; + + /** 451 Unavailable For Legal Reasons + * + * Indicates that the requested resource is unavailable due to legal reasons. + * + * The resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements. + * + * Used when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services. + * + * The resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc7725 | RFC 7725} + */ + "451"?: Response; + + //#endregion + + //#region 5xx — Server Error + + /** 500 Internal Server Error + * + * Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. + * + * The server encountered an internal error or exception that prevented it from processing the request successfully. + * + * Used for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems. + * + * The server encountered an internal error. The client should retry the request later, as this is typically a temporary issue. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-500-internal-server-error | RFC 9110 §15.6.1} + */ + "500"?: Response; + + /** 501 Not Implemented + * + * Indicates that the server does not support the functionality required to fulfill the request. + * + * The server does not recognize the request method or lacks the ability to fulfill the request. + * + * Used when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented. + * + * The server does not support the requested functionality. The client should check the API documentation for supported methods and features. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-501-not-implemented | RFC 9110 §15.6.2} + */ + "501"?: Response; + + /** 502 Bad Gateway + * + * Indicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server. + * + * The server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access. + * + * Used in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems. + * + * The gateway received an invalid response from the upstream server. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-502-bad-gateway | RFC 9110 §15.6.3} + */ + "502"?: Response; + + /** 503 Service Unavailable + * + * Indicates that the server is temporarily unable to handle the request due to maintenance or overload. + * + * The server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints. + * + * Used during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows. + * + * The server is temporarily unavailable. The client should retry the request later, often with exponential backoff. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-503-service-unavailable | RFC 9110 §15.6.4} + */ + "503"?: Response; + + /** 504 Gateway Timeout + * + * Indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server. + * + * The gateway or proxy server timed out while waiting for a response from the upstream server. + * + * Used in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times. + * + * The gateway timed out waiting for the upstream server. The client should retry the request later. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-504-gateway-timeout | RFC 9110 §15.6.5} + */ + "504"?: Response; + + /** 505 HTTP Version Not Supported + * + * Indicates that the server does not support the HTTP protocol version used in the request. + * + * The server does not support the HTTP protocol version specified in the request. + * + * Used when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios. + * + * The server does not support the HTTP version used in the request. The client should use a supported HTTP version. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc9110.html#name-505-http-version-not-supporte | RFC 9110 §15.6.6} + */ + "505"?: Response; + + /** 506 Variant Also Negotiates + * + * Indicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation. + * + * The server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop. + * + * Used in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations. + * + * The server has a configuration error in content negotiation. The client should contact the server administrator. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2295 | RFC 2295} + */ + "506"?: Response; + + /** 507 Insufficient Storage + * + * Indicates that the server is unable to store the representation needed to complete the request. + * + * The server cannot store the representation required to complete the request, typically due to storage space limitations. + * + * Used in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms. + * + * The server cannot store the required representation. The client should check storage availability and retry the request. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc4918 | RFC 4918 (WebDAV)} + */ + "507"?: Response; + + /** 508 Loop Detected + * + * Indicates that the server detected an infinite loop while processing the request. + * + * The server detected an infinite loop in the request processing, typically in WebDAV operations. + * + * Used in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios. + * + * The server detected an infinite loop. The client should check the request for circular references and retry. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc5842 | RFC 5842 (WebDAV)} + */ + "508"?: Response; + + /** 510 Not Extended — OBSOLETED + * + * This status code is obsolete and should not be used in modern implementations. + * + * This status code was used for HTTP extensions but is now obsolete and should not be used. + * + * Not used in modern web applications. This code is obsolete and should not be implemented. + * + * This status code should not be encountered in modern web applications. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc2774 | RFC 2774 (Historic)} + * @see {@link https://datatracker.ietf.org/doc/status-change-http-experiments-to-historic/ | IETF: Status change of HTTP experiments to Historic} + */ + "510"?: Response; + + /** 511 Network Authentication Required + * + * Indicates that the client needs to authenticate to gain network access. + * + * The client must authenticate with the network before it can access the requested resource. + * + * Used in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication. + * + * The client needs to authenticate with the network. The client should follow the authentication process provided by the network. + * + * @see {@link https://www.rfc-editor.org/rfc/rfc6585 | RFC 6585} + */ + "511"?: Response; + + //#endregion + + /** default — The default response for all codes not covered individually. */ + default?: Response; } diff --git a/3.2/tags.ts b/3.2/tags.ts index 2a67cf2..19e0d75 100644 --- a/3.2/tags.ts +++ b/3.2/tags.ts @@ -54,27 +54,27 @@ import type { ExternalDocumentation } from "./externalDocs"; * ``` */ export interface Tag extends Extension { - /** - * The name of the tag. This field is required. - * - * @example "users" - * @example "pets" - * @example "authentication" - */ - name: string; + /** + * The name of the tag. This field is required. + * + * @example "users" + * @example "pets" + * @example "authentication" + */ + name: string; - /** - * A short description for the tag. CommonMark syntax MAY be used for rich text representation. - * - * @example "User management operations" - * @example "Pet store operations" - */ - description?: string; + /** + * A short description for the tag. CommonMark syntax MAY be used for rich text representation. + * + * @example "User management operations" + * @example "Pet store operations" + */ + description?: string; - /** - * Additional external documentation for this tag. - * - * @example { description: "Find out more about user management", url: "https://example.com/docs/users" } - */ - externalDocs?: ExternalDocumentation; + /** + * Additional external documentation for this tag. + * + * @example { description: "Find out more about user management", url: "https://example.com/docs/users" } + */ + externalDocs?: ExternalDocumentation; } diff --git a/3.2/xml.ts b/3.2/xml.ts index cf6dffc..f600707 100644 --- a/3.2/xml.ts +++ b/3.2/xml.ts @@ -130,51 +130,51 @@ import type { Extension } from "./extensions"; * ``` */ export interface XML extends Extension { - /** - * The type of XML node this schema produces. Determines how the schema - * is serialized to XML. - * - * - `"element"`: Produces an XML element node (may contain attributes, child elements, or text) - * - `"attribute"`: Produces an XML attribute node on the containing element (value-only) - * - `"text"`: Contributes character data of the containing element (PCDATA) - * - `"cdata"`: Contributes a CDATA section of the containing element - * - `"none"`: Does not directly produce a node (used for structural control, e.g., array wrappers) - * - * @example "element" - * @example "attribute" - * @example "text" - * @example "cdata" - * @example "none" - */ - nodeType?: "element" | "attribute" | "text" | "cdata" | "none"; + /** + * The type of XML node this schema produces. Determines how the schema + * is serialized to XML. + * + * - `"element"`: Produces an XML element node (may contain attributes, child elements, or text) + * - `"attribute"`: Produces an XML attribute node on the containing element (value-only) + * - `"text"`: Contributes character data of the containing element (PCDATA) + * - `"cdata"`: Contributes a CDATA section of the containing element + * - `"none"`: Does not directly produce a node (used for structural control, e.g., array wrappers) + * + * @example "element" + * @example "attribute" + * @example "text" + * @example "cdata" + * @example "none" + */ + nodeType?: "element" | "attribute" | "text" | "cdata" | "none"; - /** - * Replaces the name of the element/attribute used for the described schema property. - * Only effective when `nodeType` is "element" or "attribute". When defined within - * the Items Object (items), it will affect the name of the individual XML elements - * within the list. When defined alongside type being array (outside the items), - * it will affect the wrapping element name. - * - * @example "user" - * @example "id" - * @example "users" - */ - name?: string; + /** + * Replaces the name of the element/attribute used for the described schema property. + * Only effective when `nodeType` is "element" or "attribute". When defined within + * the Items Object (items), it will affect the name of the individual XML elements + * within the list. When defined alongside type being array (outside the items), + * it will affect the wrapping element name. + * + * @example "user" + * @example "id" + * @example "users" + */ + name?: string; - /** - * The URI of the namespace definition. This MUST be in the form of an absolute URI. - * Only effective when `nodeType` is "element" or "attribute". - * - * @example "http://example.com/schema/user" - * @example "http://www.w3.org/XML/1998/namespace" - */ - namespace?: string; + /** + * The URI of the namespace definition. This MUST be in the form of an absolute URI. + * Only effective when `nodeType` is "element" or "attribute". + * + * @example "http://example.com/schema/user" + * @example "http://www.w3.org/XML/1998/namespace" + */ + namespace?: string; - /** - * The prefix to be used for the name. Only effective when `nodeType` is "element" or "attribute". - * - * @example "user" - * @example "xml" - */ - prefix?: string; + /** + * The prefix to be used for the name. Only effective when `nodeType` is "element" or "attribute". + * + * @example "user" + * @example "xml" + */ + prefix?: string; } diff --git a/License.ts b/License.ts index 278b563..16e6a5e 100644 --- a/License.ts +++ b/License.ts @@ -18,8 +18,7 @@ type OpenEnum = T | (string & { __openEnum?: never }); * @see {@link https://spdx.org/licenses/ | SPDX License List} * @see {@link https://www.npmjs.com/package/spdx-license-list | spdx-license-list NPM Package} */ -export type KnownLicenseNames = - (typeof spdxLicenseList)[keyof typeof spdxLicenseList]["name"]; +export type KnownLicenseNames = (typeof spdxLicenseList)[keyof typeof spdxLicenseList]["name"]; /** * Known license SPDX Identifiers. @@ -40,13 +39,13 @@ export type KnownLicenseIdentifiers = keyof typeof spdxLicenseList; * @see {@link https://www.npmjs.com/package/spdx-license-list | spdx-license-list NPM Package} */ export type KnownLicenseURLs = { - [K in keyof typeof spdxLicenseList]: (typeof spdxLicenseList)[K] extends { - url: infer U; - } - ? U extends string - ? U - : never - : never; + [K in keyof typeof spdxLicenseList]: (typeof spdxLicenseList)[K] extends { + url: infer U; + } + ? U extends string + ? U + : never + : never; }[keyof typeof spdxLicenseList]; /** diff --git a/README.md b/README.md index 54fda3f..0c8fcb8 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ The build process creates JSON schemas for: ```typescript // Import schemas for a specific version -import { schemas } from 'oas-types/schemas/3.0'; +import { schemas } from "oas-types/schemas/3.0"; // Import all schemas -import { allSchemas } from 'oas-types/schemas'; +import { allSchemas } from "oas-types/schemas"; // Use with JSON Schema validators -import Ajv from 'ajv'; +import Ajv from "ajv"; const ajv = new Ajv(); const validator = ajv.compile(schemas.specification); ``` @@ -65,66 +65,42 @@ const validator = ajv.compile(schemas.specification); ```typescript // OpenAPI 3.2.0 (latest) -import { - Specification, - Info, - Paths, - Schema, - Components -} from 'oas-types/3.2'; +import { Specification, Info, Paths, Schema, Components } from "oas-types/3.2"; // OpenAPI 3.1.x -import { - Specification, - Info, - Paths, - Schema, - Components -} from 'oas-types/3.1'; +import { Specification, Info, Paths, Schema, Components } from "oas-types/3.1"; // OpenAPI 3.0.x -import { - Specification, - Info, - Paths, - Schema, - Components -} from 'oas-types/3.0'; +import { Specification, Info, Paths, Schema, Components } from "oas-types/3.0"; // Swagger 2.0 -import { - Swagger, - Info, - Paths, - Schema, - Definitions -} from 'oas-types/2.0'; +import { Swagger, Info, Paths, Schema, Definitions } from "oas-types/2.0"; ``` ### Import Specific OpenAPI Objects ```typescript // Import specific objects from any version -import { Info, Contact, License } from 'oas-types/3.1/info'; -import { Paths, Operation, Parameter } from 'oas-types/3.1/paths'; -import { Schema, StringSchema, ObjectSchema } from 'oas-types/3.1/schema'; -import { SecurityScheme, OAuthFlows } from 'oas-types/3.1/security'; +import { Info, Contact, License } from "oas-types/3.1/info"; +import { Paths, Operation, Parameter } from "oas-types/3.1/paths"; +import { Schema, StringSchema, ObjectSchema } from "oas-types/3.1/schema"; +import { SecurityScheme, OAuthFlows } from "oas-types/3.1/security"; ``` ### Import Schema Data Types ```typescript // Import specific schema types for any version -import { - StringSchema, - NumberSchema, - IntegerSchema, +import { + StringSchema, + NumberSchema, + IntegerSchema, BooleanSchema, - ArraySchema, + ArraySchema, ObjectSchema, CompositionSchema, - ReferenceSchema -} from 'oas-types/3.1/data-types'; + ReferenceSchema, +} from "oas-types/3.1/data-types"; ``` ## Project Structure @@ -190,19 +166,25 @@ openapi-types/ ## Philosophy ### Version-Specific Implementations + Each OpenAPI version has its own complete implementation that accurately reflects the specification for that version. This ensures: + - **Type accuracy** - Types match the exact specification requirements - **Version compatibility** - No confusion between different OpenAPI versions - **Future-proofing** - Easy to add new versions without breaking existing ones ### Modular Organization + Types are organized by OpenAPI object type, making it easy to: + - Import only what you need - Understand the structure of OpenAPI specifications - Maintain and update specific object types ### Comprehensive Documentation + Every type includes: + - **JSDoc comments** with detailed descriptions - **Links to official specifications** for each OpenAPI version - **Usage examples** showing practical implementations @@ -220,7 +202,7 @@ Every type includes: ### Basic OpenAPI 3.1.x Usage ```typescript -import { Specification, Info, Paths, Schema } from 'oas-types/3.1'; +import { Specification, Info, Paths, Schema } from "oas-types/3.1"; const openApiSpec: Specification = { openapi: "3.1.0", @@ -230,12 +212,12 @@ const openApiSpec: Specification = { description: "A sample API", contact: { name: "API Support", - email: "support@example.com" + email: "support@example.com", }, license: { name: "MIT", - identifier: "MIT" - } + identifier: "MIT", + }, } as Info, paths: { "/users": { @@ -248,27 +230,22 @@ const openApiSpec: Specification = { "application/json": { schema: { type: "array", - items: { $ref: "#/components/schemas/User" } - } - } - } - } - } - } - } - } as Paths + items: { $ref: "#/components/schemas/User" }, + }, + }, + }, + }, + }, + }, + }, + } as Paths, }; ``` ### Schema Definitions (OpenAPI 3.1.x) ```typescript -import { - StringSchema, - ObjectSchema, - ArraySchema, - Schema -} from 'oas-types/3.1'; +import { StringSchema, ObjectSchema, ArraySchema, Schema } from "oas-types/3.1"; // String schema with validation const nameSchema: StringSchema = { @@ -276,7 +253,7 @@ const nameSchema: StringSchema = { minLength: 1, maxLength: 100, pattern: "^[a-zA-Z\\s]+$", - description: "User's full name" + description: "User's full name", }; // Object schema with properties @@ -285,13 +262,13 @@ const userSchema: ObjectSchema = { properties: { id: { type: "integer" }, name: nameSchema, - email: { - type: "string", - format: "email" - } + email: { + type: "string", + format: "email", + }, }, required: ["id", "name", "email"], - description: "User object" + description: "User object", }; // Array schema @@ -299,21 +276,21 @@ const usersSchema: ArraySchema = { type: "array", items: userSchema, minItems: 1, - description: "Array of users" + description: "Array of users", }; ``` ### Swagger 2.0 Usage ```typescript -import { Swagger, Info, Paths } from 'oas-types/2.0'; +import { Swagger, Info, Paths } from "oas-types/2.0"; const swaggerSpec: Swagger = { swagger: "2.0", info: { title: "My API", version: "1.0.0", - description: "A sample API" + description: "A sample API", } as Info, paths: { "/users": { @@ -324,36 +301,36 @@ const swaggerSpec: Swagger = { description: "A list of users", schema: { type: "array", - items: { $ref: "#/definitions/User" } - } - } - } - } - } + items: { $ref: "#/definitions/User" }, + }, + }, + }, + }, + }, } as Paths, definitions: { User: { type: "object", properties: { id: { type: "integer" }, - name: { type: "string" } + name: { type: "string" }, }, - required: ["id", "name"] - } - } + required: ["id", "name"], + }, + }, }; ``` ### Security Schemes ```typescript -import { SecurityScheme, OAuthFlows } from 'oas-types/3.1/security'; +import { SecurityScheme, OAuthFlows } from "oas-types/3.1/security"; const apiKeyAuth: SecurityScheme = { type: "apiKey", in: "header", name: "X-API-Key", - description: "API key authentication" + description: "API key authentication", }; const oauth2Auth: SecurityScheme = { @@ -364,10 +341,10 @@ const oauth2Auth: SecurityScheme = { tokenUrl: "https://example.com/oauth/token", scopes: { "read:users": "Read user information", - "write:users": "Modify user information" - } - } - } as OAuthFlows + "write:users": "Modify user information", + }, + }, + } as OAuthFlows, }; ``` @@ -382,6 +359,7 @@ const oauth2Auth: SecurityScheme = { ## Documentation Each type includes comprehensive JSDoc documentation with: + - **Official specification links** for each OpenAPI version - **Usage examples** with practical implementations - **Property documentation** with example values and constraints @@ -391,22 +369,26 @@ Each type includes comprehensive JSDoc documentation with: ## Key Features ### OpenAPI 3.2.0 Specific Features + - **Latest OpenAPI specification** - Full support for OpenAPI 3.2.0 features - **Enhanced OAuth flows** - Support for all OAuth 2.0 flow types - **Advanced webhook support** - Comprehensive webhook definitions ### OpenAPI 3.1.x Specific Features + - **JSON Schema 2020-12 alignment** - Full support for latest JSON Schema features - **Discriminated schema unions** - Type-safe schema type discrimination - **Composition schemas** - Support for `allOf`, `anyOf`, `oneOf`, `not`, `if`/`then`/`else` - **Enhanced validation** - Support for `const`, `examples`, and advanced validation keywords ### OpenAPI 3.0.x Features + - **Nullable schemas** - Support for `nullable` property - **Discriminator objects** - Support for schema discrimination - **Callback objects** - Support for webhook definitions ### Swagger 2.0 Features + - **Definitions object** - Support for schema definitions - **Security definitions** - Support for security schemes - **Response definitions** - Support for reusable response definitions @@ -414,6 +396,7 @@ Each type includes comprehensive JSDoc documentation with: ## Contributing Contributions are welcome! Please ensure that: + - All types follow the OpenAPI specification exactly - JSDoc documentation is complete and accurate - Version compatibility is maintained @@ -428,4 +411,4 @@ MIT License - see LICENSE file for details. - [OpenAPI Specification](https://spec.openapis.org/) - [Swagger Specification](https://swagger.io/specification/) - [JSON Schema](https://json-schema.org/) -- [SPDX License List](https://spdx.org/licenses/) \ No newline at end of file +- [SPDX License List](https://spdx.org/licenses/) diff --git a/SPDXLicenseList.ts b/SPDXLicenseList.ts index 70eb4c2..fee4693 100644 --- a/SPDXLicenseList.ts +++ b/SPDXLicenseList.ts @@ -5,3402 +5,3402 @@ * @see https://spdx.org/licenses/ */ export const spdxLicenseList = { - DSDP: { - name: "DSDP License", - url: "https://fedoraproject.org/wiki/Licensing/DSDP", - osiApproved: false, - }, - "NIST-PD": { - name: "NIST Public Domain Notice", - url: "https://github.com/tcheneau/simpleRPL/blob/e645e69e38dd4e3ccfeceb2db8cba05b7c2e0cd3/LICENSE.txt", - osiApproved: false, - }, - "CC-BY-NC-SA-2.0": { - name: "Creative Commons Attribution Non Commercial Share Alike 2.0 Generic", - url: "https://creativecommons.org/licenses/by-nc-sa/2.0/legalcode", - osiApproved: false, - }, - "NLOD-1.0": { - name: "Norwegian Licence for Open Government Data (NLOD) 1.0", - url: "http://data.norge.no/nlod/en/1.0", - osiApproved: false, - }, - "RHeCos-1.1": { - name: "Red Hat eCos Public License v1.1", - url: "http://ecos.sourceware.org/old-license.html", - osiApproved: false, - }, - "GFDL-1.3-no-invariants-only": { - name: "GNU Free Documentation License v1.3 only - no invariants", - url: "https://www.gnu.org/licenses/fdl-1.3.txt", - osiApproved: false, - }, - RSCPL: { - name: "Ricoh Source Code Public License", - url: "http://wayback.archive.org/web/20060715140826/http://www.risource.org/RPL/RPL-1.0A.shtml", - osiApproved: true, - }, - "ASWF-Digital-Assets-1.1": { - name: "ASWF Digital Assets License 1.1", - url: "https://github.com/AcademySoftwareFoundation/foundation/blob/main/digital_assets/aswf_digital_assets_license_v1.1.txt", - osiApproved: false, - }, - "eCos-2.0": { - name: "eCos license version 2.0", - url: "https://www.gnu.org/licenses/ecos-license.html", - osiApproved: false, - }, - GLWTPL: { - name: "Good Luck With That Public License", - url: "https://github.com/me-shaon/GLWTPL/commit/da5f6bc734095efbacb442c0b31e33a65b9d6e85", - osiApproved: false, - }, - "Info-ZIP": { - name: "Info-ZIP License", - url: "http://www.info-zip.org/license.html", - osiApproved: false, - }, - "LPPL-1.3c": { - name: "LaTeX Project Public License v1.3c", - url: "http://www.latex-project.org/lppl/lppl-1-3c.txt", - osiApproved: true, - }, - "zlib-acknowledgement": { - name: "zlib/libpng License with Acknowledgement", - url: "https://fedoraproject.org/wiki/Licensing/ZlibWithAcknowledgement", - osiApproved: false, - }, - checkmk: { - name: "Checkmk License", - url: "https://github.com/libcheck/check/blob/master/checkmk/checkmk.in", - osiApproved: false, - }, - "OLDAP-2.8": { - name: "Open LDAP Public License v2.8", - url: "http://www.openldap.org/software/release/license.html", - osiApproved: true, - }, - "cve-tou": { - name: "Common Vulnerability Enumeration ToU License", - url: "https://www.cve.org/Legal/TermsOfUse", - osiApproved: false, - }, - MirOS: { - name: "The MirOS Licence", - url: "https://opensource.org/licenses/MirOS", - osiApproved: true, - }, - "Parity-6.0.0": { - name: "The Parity Public License 6.0.0", - url: "https://paritylicense.com/versions/6.0.0.html", - osiApproved: false, - }, - "CC-BY-SA-2.1-JP": { - name: "Creative Commons Attribution Share Alike 2.1 Japan", - url: "https://creativecommons.org/licenses/by-sa/2.1/jp/legalcode", - osiApproved: false, - }, - InnoSetup: { - name: "Inno Setup License", - url: "https://github.com/jrsoftware/issrc/blob/HEAD/license.txt", - osiApproved: false, - }, - "IPL-1.0": { - name: "IBM Public License v1.0", - url: "https://opensource.org/licenses/IPL-1.0", - osiApproved: true, - }, - "Spencer-86": { - name: "Spencer License 86", - url: "https://fedoraproject.org/wiki/Licensing/Henry_Spencer_Reg-Ex_Library_License", - osiApproved: false, - }, - JPNIC: { - name: "Japan Network Information Center License", - url: "https://gitlab.isc.org/isc-projects/bind9/blob/master/COPYRIGHT#L366", - osiApproved: false, - }, - OpenVision: { - name: "OpenVision License", - url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L66-L98", - osiApproved: false, - }, - SGP4: { - name: "SGP4 Permission Notice", - url: "https://celestrak.org/publications/AIAA/2006-6753/faq.php", - osiApproved: false, - }, - "MPL-1.1": { - name: "Mozilla Public License 1.1", - url: "http://www.mozilla.org/MPL/MPL-1.1.html", - osiApproved: true, - }, - "BSD-3-Clause-Clear": { - name: "BSD 3-Clause Clear License", - url: "http://labs.metacarta.com/license-explanation.html#license", - osiApproved: false, - }, - "AML-glslang": { - name: "AML glslang variant License", - url: "https://github.com/KhronosGroup/glslang/blob/main/LICENSE.txt#L949", - osiApproved: false, - }, - Vim: { - name: "Vim License", - url: "http://vimdoc.sourceforge.net/htmldoc/uganda.html", - osiApproved: false, - }, - "Community-Spec-1.0": { - name: "Community Specification License 1.0", - url: "https://github.com/CommunitySpecification/1.0/blob/master/1._Community_Specification_License-v1.md", - osiApproved: false, - }, - "OSL-3.0": { - name: "Open Software License 3.0", - url: "https://web.archive.org/web/20120101081418/http://rosenlaw.com:80/OSL3.0.htm", - osiApproved: true, - }, - CrystalStacker: { - name: "CrystalStacker License", - url: "https://fedoraproject.org/wiki/Licensing:CrystalStacker?rd=Licensing/CrystalStacker", - osiApproved: false, - }, - "MPL-1.0": { - name: "Mozilla Public License 1.0", - url: "http://www.mozilla.org/MPL/MPL-1.0.html", - osiApproved: true, - }, - "OLDAP-1.2": { - name: "Open LDAP Public License v1.2", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=42b0383c50c299977b5893ee695cf4e486fb0dc7", - osiApproved: false, - }, - "Sendmail-8.23": { - name: "Sendmail License 8.23", - url: "https://www.proofpoint.com/sites/default/files/sendmail-license.pdf", - osiApproved: false, - }, - "CMU-Mach": { - name: "CMU Mach License", - url: "https://www.cs.cmu.edu/~410/licenses.html", - osiApproved: false, - }, - xpp: { - name: "XPP License", - url: "https://fedoraproject.org/wiki/Licensing/xpp", - osiApproved: false, - }, - "GPL-2.0-with-bison-exception": { - name: "GNU General Public License v2.0 w/Bison exception", - url: "http://git.savannah.gnu.org/cgit/bison.git/tree/data/yacc.c?id=193d7c7054ba7197b0789e14965b739162319b5e#n141", - osiApproved: false, - }, - "ECL-1.0": { - name: "Educational Community License v1.0", - url: "https://opensource.org/licenses/ECL-1.0", - osiApproved: true, - }, - Plexus: { - name: "Plexus Classworlds License", - url: "https://fedoraproject.org/wiki/Licensing/Plexus_Classworlds_License", - osiApproved: false, - }, - "Elastic-2.0": { - name: "Elastic License 2.0", - url: "https://www.elastic.co/licensing/elastic-license", - osiApproved: false, - }, - "CPL-1.0": { - name: "Common Public License 1.0", - url: "https://opensource.org/licenses/CPL-1.0", - osiApproved: true, - }, - "GFDL-1.2-no-invariants-only": { - name: "GNU Free Documentation License v1.2 only - no invariants", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", - osiApproved: false, - }, - "OPL-1.0": { - name: "Open Public License v1.0", - url: "http://old.koalateam.com/jackaroo/OPL_1_0.TXT", - osiApproved: false, - }, - "CC-BY-SA-4.0": { - name: "Creative Commons Attribution Share Alike 4.0 International", - url: "https://creativecommons.org/licenses/by-sa/4.0/legalcode", - osiApproved: false, - }, - ADSL: { - name: "Amazon Digital Services License", - url: "https://fedoraproject.org/wiki/Licensing/AmazonDigitalServicesLicense", - osiApproved: false, - }, - "SGI-B-1.1": { - name: "SGI Free Software License B v1.1", - url: "http://oss.sgi.com/projects/FreeB/", - osiApproved: false, - }, - "XFree86-1.1": { - name: "XFree86 License 1.1", - url: "http://www.xfree86.org/current/LICENSE4.html", - osiApproved: false, - }, - "Latex2e-translated-notice": { - name: "Latex2e with translated notice permission", - url: "https://git.savannah.gnu.org/cgit/indent.git/tree/doc/indent.texi?id=a74c6b4ee49397cf330b333da1042bffa60ed14f#n74", - osiApproved: false, - }, - IPA: { - name: "IPA Font License", - url: "https://opensource.org/licenses/IPA", - osiApproved: true, - }, - psutils: { - name: "psutils License", - url: "https://fedoraproject.org/wiki/Licensing/psutils", - osiApproved: false, - }, - "CC-BY-NC-ND-3.0": { - name: "Creative Commons Attribution Non Commercial No Derivatives 3.0 Unported", - url: "https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode", - osiApproved: false, - }, - FSFULLR: { - name: "FSF Unlimited License (with License Retention)", - url: "https://fedoraproject.org/wiki/Licensing/FSF_Unlimited_License#License_Retention_Variant", - osiApproved: false, - }, - "SSLeay-standalone": { - name: "SSLeay License - standalone", - url: "https://www.tq-group.com/filedownloads/files/software-license-conditions/OriginalSSLeay/OriginalSSLeay.pdf", - osiApproved: false, - }, - MMIXware: { - name: "MMIXware License", - url: "https://gitlab.lrz.de/mmix/mmixware/-/blob/master/boilerplate.w", - osiApproved: false, - }, - "Graphics-Gems": { - name: "Graphics Gems License", - url: "https://github.com/erich666/GraphicsGems/blob/master/LICENSE.md", - osiApproved: false, - }, - "HPND-export-US-acknowledgement": { - name: "HPND with US Government export control warning and acknowledgment", - url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L831-L852", - osiApproved: false, - }, - "CC-BY-NC-2.0": { - name: "Creative Commons Attribution Non Commercial 2.0 Generic", - url: "https://creativecommons.org/licenses/by-nc/2.0/legalcode", - osiApproved: false, - }, - "OLDAP-1.3": { - name: "Open LDAP Public License v1.3", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=e5f8117f0ce088d0bd7a8e18ddf37eaa40eb09b1", - osiApproved: false, - }, - "LGPL-2.1-only": { - name: "GNU Lesser General Public License v2.1 only", - url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", - osiApproved: true, - }, - "NLOD-2.0": { - name: "Norwegian Licence for Open Government Data (NLOD) 2.0", - url: "http://data.norge.no/nlod/en/2.0", - osiApproved: false, - }, - "BSD-2-Clause": { - name: 'BSD 2-Clause "Simplified" License', - url: "https://opensource.org/licenses/BSD-2-Clause", - osiApproved: true, - }, - mailprio: { - name: "mailprio License", - url: "https://fossies.org/linux/sendmail/contrib/mailprio", - osiApproved: false, - }, - "CC-BY-SA-3.0": { - name: "Creative Commons Attribution Share Alike 3.0 Unported", - url: "https://creativecommons.org/licenses/by-sa/3.0/legalcode", - osiApproved: false, - }, - Noweb: { - name: "Noweb License", - url: "https://fedoraproject.org/wiki/Licensing/Noweb", - osiApproved: false, - }, - Soundex: { - name: "Soundex License", - url: "https://metacpan.org/release/RJBS/Text-Soundex-3.05/source/Soundex.pm#L3-11", - osiApproved: false, - }, - "CECILL-1.0": { - name: "CeCILL Free Software License Agreement v1.0", - url: "http://www.cecill.info/licences/Licence_CeCILL_V1-fr.html", - osiApproved: false, - }, - Aladdin: { - name: "Aladdin Free Public License", - url: "http://pages.cs.wisc.edu/~ghost/doc/AFPL/6.01/Public.htm", - osiApproved: false, - }, - "SSH-OpenSSH": { - name: "SSH OpenSSH license", - url: "https://github.com/openssh/openssh-portable/blob/1b11ea7c58cd5c59838b5fa574cd456d6047b2d4/LICENCE#L10", - osiApproved: false, - }, - "BSD-Attribution-HPND-disclaimer": { - name: "BSD with Attribution and HPND disclaimer", - url: "https://github.com/cyrusimap/cyrus-sasl/blob/master/COPYING", - osiApproved: false, - }, - "CC-BY-NC-SA-2.0-UK": { - name: "Creative Commons Attribution Non Commercial Share Alike 2.0 England and Wales", - url: "https://creativecommons.org/licenses/by-nc-sa/2.0/uk/legalcode", - osiApproved: false, - }, - Kazlib: { - name: "Kazlib License", - url: "http://git.savannah.gnu.org/cgit/kazlib.git/tree/except.c?id=0062df360c2d17d57f6af19b0e444c51feb99036", - osiApproved: false, - }, - "Ubuntu-font-1.0": { - name: "Ubuntu Font Licence v1.0", - url: "https://ubuntu.com/legal/font-licence", - osiApproved: false, - }, - "SGI-OpenGL": { - name: "SGI OpenGL License", - url: "https://gitlab.freedesktop.org/mesa/glw/-/blob/master/README?ref_type=heads", - osiApproved: false, - }, - Rdisc: { - name: "Rdisc License", - url: "https://fedoraproject.org/wiki/Licensing/Rdisc_License", - osiApproved: false, - }, - "HPND-sell-variant-MIT-disclaimer": { - name: "HPND sell variant with MIT disclaimer", - url: "https://github.com/sigmavirus24/x11-ssh-askpass/blob/master/README", - osiApproved: false, - }, - LGPLLR: { - name: "Lesser General Public License For Linguistic Resources", - url: "http://www-igm.univ-mlv.fr/~unitex/lgpllr.html", - osiApproved: false, - }, - OAR: { - name: "OAR License", - url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/string/strsignal.c;hb=HEAD#l35", - osiApproved: false, - }, - HTMLTIDY: { - name: "HTML Tidy License", - url: "https://github.com/htacg/tidy-html5/blob/next/README/LICENSE.md", - osiApproved: false, - }, - AMPAS: { - name: "Academy of Motion Picture Arts and Sciences BSD", - url: "https://fedoraproject.org/wiki/Licensing/BSD#AMPASBSD", - osiApproved: false, - }, - NOSL: { - name: "Netizen Open Source License", - url: "http://bits.netizen.com.au/licenses/NOSL/nosl.txt", - osiApproved: false, - }, - fwlw: { - name: "fwlw License", - url: "https://mirrors.nic.cz/tex-archive/macros/latex/contrib/fwlw/README", - osiApproved: false, - }, - w3m: { - name: "w3m License", - url: "https://github.com/tats/w3m/blob/master/COPYING", - osiApproved: false, - }, - Latex2e: { - name: "Latex2e License", - url: "https://fedoraproject.org/wiki/Licensing/Latex2e", - osiApproved: false, - }, - "O-UDA-1.0": { - name: "Open Use of Data Agreement v1.0", - url: "https://github.com/microsoft/Open-Use-of-Data-Agreement/blob/v1.0/O-UDA-1.0.md", - osiApproved: false, - }, - mplus: { - name: "mplus Font License", - url: "https://fedoraproject.org/wiki/Licensing:Mplus?rd=Licensing/mplus", - osiApproved: false, - }, - "HPND-Intel": { - name: "Historical Permission Notice and Disclaimer - Intel variant", - url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/machine/i960/memcpy.S;hb=HEAD", - osiApproved: false, - }, - PPL: { - name: "Peer Production License", - url: "https://wiki.p2pfoundation.net/Peer_Production_License", - osiApproved: false, - }, - "OFL-1.1-RFN": { - name: "SIL Open Font License 1.1 with Reserved Font Name", - url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web", - osiApproved: true, - }, - "EPL-1.0": { - name: "Eclipse Public License 1.0", - url: "http://www.eclipse.org/legal/epl-v10.html", - osiApproved: true, - }, - "HPND-UC-export-US": { - name: "Historical Permission Notice and Disclaimer - University of California, US export warning", - url: "https://github.com/RTimothyEdwards/magic/blob/master/LICENSE", - osiApproved: false, - }, - "CC-BY-3.0-DE": { - name: "Creative Commons Attribution 3.0 Germany", - url: "https://creativecommons.org/licenses/by/3.0/de/legalcode", - osiApproved: false, - }, - SNIA: { - name: "SNIA Public License 1.1", - url: "https://fedoraproject.org/wiki/Licensing/SNIA_Public_License", - osiApproved: false, - }, - Barr: { - name: "Barr License", - url: "https://fedoraproject.org/wiki/Licensing/Barr", - osiApproved: false, - }, - "OLDAP-2.1": { - name: "Open LDAP Public License v2.1", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=b0d176738e96a0d3b9f85cb51e140a86f21be715", - osiApproved: false, - }, - "CC-BY-ND-4.0": { - name: "Creative Commons Attribution No Derivatives 4.0 International", - url: "https://creativecommons.org/licenses/by-nd/4.0/legalcode", - osiApproved: false, - }, - softSurfer: { - name: "softSurfer License", - url: "https://github.com/mm2/Little-CMS/blob/master/src/cmssm.c#L207", - osiApproved: false, - }, - "LGPL-2.1-or-later": { - name: "GNU Lesser General Public License v2.1 or later", - url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", - osiApproved: true, - }, - "OFL-1.0": { - name: "SIL Open Font License 1.0", - url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL10_web", - osiApproved: false, - }, - "BSD-3-Clause-flex": { - name: "BSD 3-Clause Flex variant", - url: "https://github.com/westes/flex/blob/master/COPYING", - osiApproved: false, - }, - psfrag: { - name: "psfrag License", - url: "https://fedoraproject.org/wiki/Licensing/psfrag", - osiApproved: false, - }, - "BSD-1-Clause": { - name: "BSD 1-Clause License", - url: "https://svnweb.freebsd.org/base/head/include/ifaddrs.h?revision=326823", - osiApproved: true, - }, - "BSD-3-Clause-No-Military-License": { - name: "BSD 3-Clause No Military License", - url: "https://gitlab.syncad.com/hive/dhive/-/blob/master/LICENSE", - osiApproved: false, - }, - Cube: { - name: "Cube License", - url: "https://fedoraproject.org/wiki/Licensing/Cube", - osiApproved: false, - }, - "LPPL-1.2": { - name: "LaTeX Project Public License v1.2", - url: "http://www.latex-project.org/lppl/lppl-1-2.txt", - osiApproved: false, - }, - "OLDAP-2.2.2": { - name: "Open LDAP Public License 2.2.2", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=df2cc1e21eb7c160695f5b7cffd6296c151ba188", - osiApproved: false, - }, - TTWL: { - name: "Text-Tabs+Wrap License", - url: "https://fedoraproject.org/wiki/Licensing/TTWL", - osiApproved: false, - }, - "CC-BY-3.0": { - name: "Creative Commons Attribution 3.0 Unported", - url: "https://creativecommons.org/licenses/by/3.0/legalcode", - osiApproved: false, - }, - "BSD-3-Clause-Open-MPI": { - name: "BSD 3-Clause Open MPI variant", - url: "https://www.open-mpi.org/community/license.php", - osiApproved: false, - }, - "CC-BY-NC-ND-3.0-IGO": { - name: "Creative Commons Attribution Non Commercial No Derivatives 3.0 IGO", - url: "https://creativecommons.org/licenses/by-nc-nd/3.0/igo/legalcode", - osiApproved: false, - }, - "ZPL-2.1": { - name: "Zope Public License 2.1", - url: "http://old.zope.org/Resources/ZPL/", - osiApproved: true, - }, - "CC0-1.0": { - name: "Creative Commons Zero v1.0 Universal", - url: "https://creativecommons.org/publicdomain/zero/1.0/legalcode", - osiApproved: false, - }, - "NPL-1.0": { - name: "Netscape Public License v1.0", - url: "http://www.mozilla.org/MPL/NPL/1.0/", - osiApproved: false, - }, - "CECILL-2.0": { - name: "CeCILL Free Software License Agreement v2.0", - url: "http://www.cecill.info/licences/Licence_CeCILL_V2-en.html", - osiApproved: false, - }, - wwl: { - name: "WWL License", - url: "http://www.db.net/downloads/wwl+db-1.3.tgz", - osiApproved: false, - }, - NGPL: { - name: "Nethack General Public License", - url: "https://opensource.org/licenses/NGPL", - osiApproved: true, - }, - FSFAP: { - name: "FSF All Permissive License", - url: "https://www.gnu.org/prep/maintain/html_node/License-Notices-for-Other-Files.html", - osiApproved: false, - }, - "any-OSI": { - name: "Any OSI License", - url: "https://metacpan.org/pod/Exporter::Tidy#LICENSE", - osiApproved: false, - }, - mpich2: { - name: "mpich2 License", - url: "https://fedoraproject.org/wiki/Licensing/MIT", - osiApproved: false, - }, - EUDatagrid: { - name: "EU DataGrid Software License", - url: "http://eu-datagrid.web.cern.ch/eu-datagrid/license.html", - osiApproved: true, - }, - Sleepycat: { - name: "Sleepycat License", - url: "https://opensource.org/licenses/Sleepycat", - osiApproved: true, - }, - "AFL-3.0": { - name: "Academic Free License v3.0", - url: "http://www.rosenlaw.com/AFL3.0.htm", - osiApproved: true, - }, - "Arphic-1999": { - name: "Arphic Public License", - url: "http://ftp.gnu.org/gnu/non-gnu/chinese-fonts-truetype/LICENSE", - osiApproved: false, - }, - "BSD-4-Clause-UC": { - name: "BSD-4-Clause (University of California-Specific)", - url: "http://www.freebsd.org/copyright/license.html", - osiApproved: false, - }, - dtoa: { - name: "David M. Gay dtoa License", - url: "https://github.com/SWI-Prolog/swipl-devel/blob/master/src/os/dtoa.c", - osiApproved: false, - }, - "Unicode-DFS-2015": { - name: "Unicode License Agreement - Data Files and Software (2015)", - url: "https://web.archive.org/web/20151224134844/http://unicode.org/copyright.html", - osiApproved: false, - }, - "TCP-wrappers": { - name: "TCP Wrappers License", - url: "http://rc.quest.com/topics/openssh/license.php#tcpwrappers", - osiApproved: false, - }, - "MIT-0": { - name: "MIT No Attribution", - url: "https://github.com/aws/mit-0", - osiApproved: true, - }, - "SugarCRM-1.1.3": { - name: "SugarCRM Public License v1.1.3", - url: "http://www.sugarcrm.com/crm/SPL", - osiApproved: false, - }, - iMatix: { - name: "iMatix Standard Function Library Agreement", - url: "http://legacy.imatix.com/html/sfl/sfl4.htm#license", - osiApproved: false, - }, - "CC-BY-3.0-AT": { - name: "Creative Commons Attribution 3.0 Austria", - url: "https://creativecommons.org/licenses/by/3.0/at/legalcode", - osiApproved: false, - }, - "Adobe-2006": { - name: "Adobe Systems Incorporated Source Code License Agreement", - url: "https://fedoraproject.org/wiki/Licensing/AdobeLicense", - osiApproved: false, - }, - LOOP: { - name: "Common Lisp LOOP License", - url: "https://gitlab.com/embeddable-common-lisp/ecl/-/blob/develop/src/lsp/loop.lsp", - osiApproved: false, - }, - "MIT-testregex": { - name: "MIT testregex Variant", - url: "https://github.com/dotnet/runtime/blob/55e1ac7c07df62c4108d4acedf78f77574470ce5/src/libraries/System.Text.RegularExpressions/tests/FunctionalTests/AttRegexTests.cs#L12-L28", - osiApproved: false, - }, - eGenix: { - name: "eGenix.com Public License 1.1.0", - url: "http://www.egenix.com/products/eGenix.com-Public-License-1.1.0.pdf", - osiApproved: false, - }, - "GCR-docs": { - name: "Gnome GCR Documentation License", - url: "https://github.com/GNOME/gcr/blob/master/docs/COPYING", - osiApproved: false, - }, - AAL: { - name: "Attribution Assurance License", - url: "https://opensource.org/licenses/attribution", - osiApproved: true, - }, - "CAL-1.0": { - name: "Cryptographic Autonomy License 1.0", - url: "http://cryptographicautonomylicense.com/license-text.html", - osiApproved: true, - }, - "PHP-3.0": { - name: "PHP License v3.0", - url: "http://www.php.net/license/3_0.txt", - osiApproved: true, - }, - hdparm: { - name: "hdparm License", - url: "https://github.com/Distrotech/hdparm/blob/4517550db29a91420fb2b020349523b1b4512df2/LICENSE.TXT", - osiApproved: false, - }, - "OpenPBS-2.3": { - name: "OpenPBS v2.3 Software License", - url: "https://github.com/adaptivecomputing/torque/blob/master/PBS_License.txt", - osiApproved: false, - }, - "DL-DE-BY-2.0": { - name: "Data licence Germany – attribution – version 2.0", - url: "https://www.govdata.de/dl-de/by-2-0", - osiApproved: false, - }, - "GFDL-1.3-or-later": { - name: "GNU Free Documentation License v1.3 or later", - url: "https://www.gnu.org/licenses/fdl-1.3.txt", - osiApproved: false, - }, - "CERN-OHL-1.2": { - name: "CERN Open Hardware Licence v1.2", - url: "https://www.ohwr.org/project/licenses/wikis/cern-ohl-v1.2", - osiApproved: false, - }, - MIT: { - name: "MIT License", - url: "https://opensource.org/license/mit/", - osiApproved: true, - }, - XSkat: { - name: "XSkat License", - url: "https://fedoraproject.org/wiki/Licensing/XSkat_License", - osiApproved: false, - }, - Gutmann: { - name: "Gutmann License", - url: "https://www.cs.auckland.ac.nz/~pgut001/dumpasn1.c", - osiApproved: false, - }, - wxWindows: { - name: "wxWindows Library License", - url: "https://opensource.org/licenses/WXwindows", - osiApproved: true, - }, - "CC-BY-NC-SA-2.5": { - name: "Creative Commons Attribution Non Commercial Share Alike 2.5 Generic", - url: "https://creativecommons.org/licenses/by-nc-sa/2.5/legalcode", - osiApproved: false, - }, - "PDDL-1.0": { - name: "Open Data Commons Public Domain Dedication & License 1.0", - url: "http://opendatacommons.org/licenses/pddl/1.0/", - osiApproved: false, - }, - Unlicense: { - name: "The Unlicense", - url: "https://unlicense.org/", - osiApproved: true, - }, - "CUA-OPL-1.0": { - name: "CUA Office Public License v1.0", - url: "https://opensource.org/licenses/CUA-OPL-1.0", - osiApproved: true, - }, - NCL: { - name: "NCL Source Code License", - url: "https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/master/src/modules/module-filter-chain/pffft.c?ref_type=heads#L1-52", - osiApproved: false, - }, - "GFDL-1.1-invariants-or-later": { - name: "GNU Free Documentation License v1.1 or later - invariants", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", - osiApproved: false, - }, - "CECILL-2.1": { - name: "CeCILL Free Software License Agreement v2.1", - url: "http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html", - osiApproved: true, - }, - "PolyForm-Small-Business-1.0.0": { - name: "PolyForm Small Business License 1.0.0", - url: "https://polyformproject.org/licenses/small-business/1.0.0", - osiApproved: false, - }, - "HP-1986": { - name: "Hewlett-Packard 1986 License", - url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/machine/hppa/memchr.S;h=1cca3e5e8867aa4bffef1f75a5c1bba25c0c441e;hb=HEAD#l2", - osiApproved: false, - }, - "HPND-export-US": { - name: "HPND with US Government export control warning", - url: "https://www.kermitproject.org/ck90.html#source", - osiApproved: false, - }, - "X11-swapped": { - name: "X11 swapped final paragraphs", - url: "https://github.com/fedeinthemix/chez-srfi/blob/master/srfi/LICENSE", - osiApproved: false, - }, - "SHL-0.5": { - name: "Solderpad Hardware License v0.5", - url: "https://solderpad.org/licenses/SHL-0.5/", - osiApproved: false, - }, - "BSD-Systemics": { - name: "Systemics BSD variant license", - url: "https://metacpan.org/release/DPARIS/Crypt-DES-2.07/source/COPYRIGHT", - osiApproved: false, - }, - "CDLA-Sharing-1.0": { - name: "Community Data License Agreement Sharing 1.0", - url: "https://cdla.io/sharing-1-0", - osiApproved: false, - }, - "GFDL-1.1-or-later": { - name: "GNU Free Documentation License v1.1 or later", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", - osiApproved: false, - }, - Newsletr: { - name: "Newsletr License", - url: "https://fedoraproject.org/wiki/Licensing/Newsletr", - osiApproved: false, - }, - TMate: { - name: "TMate Open Source License", - url: "http://svnkit.com/license.html", - osiApproved: false, - }, - EPICS: { - name: "EPICS Open License", - url: "https://epics.anl.gov/license/open.php", - osiApproved: false, - }, - "SAX-PD": { - name: "Sax Public Domain Notice", - url: "http://www.saxproject.org/copying.html", - osiApproved: false, - }, - "MIT-Festival": { - name: "MIT Festival Variant", - url: "https://github.com/festvox/flite/blob/master/COPYING", - osiApproved: false, - }, - "LGPL-2.0-or-later": { - name: "GNU Library General Public License v2 or later", - url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", - osiApproved: true, - }, - "QPL-1.0": { - name: "Q Public License 1.0", - url: "http://doc.qt.nokia.com/3.3/license.html", - osiApproved: true, - }, - "SSH-short": { - name: "SSH short notice", - url: "https://github.com/openssh/openssh-portable/blob/1b11ea7c58cd5c59838b5fa574cd456d6047b2d4/pathnames.h", - osiApproved: false, - }, - "OGL-UK-1.0": { - name: "Open Government Licence v1.0", - url: "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/1/", - osiApproved: false, - }, - "GPL-2.0-only": { - name: "GNU General Public License v2.0 only", - url: "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", - osiApproved: true, - }, - "GPL-3.0-with-GCC-exception": { - name: "GNU General Public License v3.0 w/GCC Runtime Library exception", - url: "https://www.gnu.org/licenses/gcc-exception-3.1.html", - osiApproved: true, - }, - "ECL-2.0": { - name: "Educational Community License v2.0", - url: "https://opensource.org/licenses/ECL-2.0", - osiApproved: true, - }, - "CATOSL-1.1": { - name: "Computer Associates Trusted Open Source License 1.1", - url: "https://opensource.org/licenses/CATOSL-1.1", - osiApproved: true, - }, - "Cornell-Lossless-JPEG": { - name: "Cornell Lossless JPEG License", - url: "https://android.googlesource.com/platform/external/dng_sdk/+/refs/heads/master/source/dng_lossless_jpeg.cpp#16", - osiApproved: false, - }, - DOC: { - name: "DOC License", - url: "http://www.cs.wustl.edu/~schmidt/ACE-copying.html", - osiApproved: false, - }, - "RSA-MD": { - name: "RSA Message-Digest License", - url: "http://www.faqs.org/rfcs/rfc1321.html", - osiApproved: false, - }, - "OCLC-2.0": { - name: "OCLC Research Public License 2.0", - url: "http://www.oclc.org/research/activities/software/license/v2final.htm", - osiApproved: true, - }, - "AGPL-3.0-only": { - name: "GNU Affero General Public License v3.0 only", - url: "https://www.gnu.org/licenses/agpl.txt", - osiApproved: true, - }, - "OLDAP-2.5": { - name: "Open LDAP Public License v2.5", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=6852b9d90022e8593c98205413380536b1b5a7cf", - osiApproved: false, - }, - "CC-BY-SA-3.0-DE": { - name: "Creative Commons Attribution Share Alike 3.0 Germany", - url: "https://creativecommons.org/licenses/by-sa/3.0/de/legalcode", - osiApproved: false, - }, - "Artistic-1.0-Perl": { - name: "Artistic License 1.0 (Perl)", - url: "http://dev.perl.org/licenses/artistic.html", - osiApproved: true, - }, - "CC-BY-NC-ND-4.0": { - name: "Creative Commons Attribution Non Commercial No Derivatives 4.0 International", - url: "https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode", - osiApproved: false, - }, - "BSD-3-Clause-No-Nuclear-License-2014": { - name: "BSD 3-Clause No Nuclear License 2014", - url: "https://java.net/projects/javaeetutorial/pages/BerkeleyLicense", - osiApproved: false, - }, - "Martin-Birgmeier": { - name: "Martin Birgmeier License", - url: "https://github.com/Perl/perl5/blob/blead/util.c#L6136", - osiApproved: false, - }, - "EUPL-1.0": { - name: "European Union Public License 1.0", - url: "http://ec.europa.eu/idabc/en/document/7330.html", - osiApproved: false, - }, - "GPL-2.0": { - name: "GNU General Public License v2.0 only", - url: "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", - osiApproved: true, - }, - "McPhee-slideshow": { - name: "McPhee Slideshow License", - url: "https://mirror.las.iastate.edu/tex-archive/graphics/metapost/contrib/macros/slideshow/slideshow.mp", - osiApproved: false, - }, - "CC-BY-NC-ND-1.0": { - name: "Creative Commons Attribution Non Commercial No Derivatives 1.0 Generic", - url: "https://creativecommons.org/licenses/by-nd-nc/1.0/legalcode", - osiApproved: false, - }, - "BlueOak-1.0.0": { - name: "Blue Oak Model License 1.0.0", - url: "https://blueoakcouncil.org/license/1.0.0", - osiApproved: true, - }, - "ODC-By-1.0": { - name: "Open Data Commons Attribution License v1.0", - url: "https://opendatacommons.org/licenses/by/1.0/", - osiApproved: false, - }, - "COIL-1.0": { - name: "Copyfree Open Innovation License", - url: "https://coil.apotheon.org/plaintext/01.0.txt", - osiApproved: false, - }, - "Bitstream-Vera": { - name: "Bitstream Vera Font License", - url: "https://web.archive.org/web/20080207013128/http://www.gnome.org/fonts/", - osiApproved: false, - }, - "JPL-image": { - name: "JPL Image Use Policy", - url: "https://www.jpl.nasa.gov/jpl-image-use-policy", - osiApproved: false, - }, - "MIT-enna": { - name: "enna License", - url: "https://fedoraproject.org/wiki/Licensing/MIT#enna", - osiApproved: false, - }, - "BSD-Inferno-Nettverk": { - name: "BSD-Inferno-Nettverk", - url: "https://www.inet.no/dante/LICENSE", - osiApproved: false, - }, - "CDDL-1.1": { - name: "Common Development and Distribution License 1.1", - url: "http://glassfish.java.net/public/CDDL+GPL_1_1.html", - osiApproved: false, - }, - FSFULLRWD: { - name: "FSF Unlimited License (With License Retention and Warranty Disclaimer)", - url: "https://lists.gnu.org/archive/html/autoconf/2012-04/msg00061.html", - osiApproved: false, - }, - "GFDL-1.2-invariants-only": { - name: "GNU Free Documentation License v1.2 only - invariants", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", - osiApproved: false, - }, - "EFL-1.0": { - name: "Eiffel Forum License v1.0", - url: "http://www.eiffel-nice.org/license/forum.txt", - osiApproved: true, - }, - Entessa: { - name: "Entessa Public License v1.0", - url: "https://opensource.org/licenses/Entessa", - osiApproved: true, - }, - Glide: { - name: "3dfx Glide License", - url: "http://www.users.on.net/~triforce/glidexp/COPYING.txt", - osiApproved: false, - }, - "CC-BY-NC-3.0-DE": { - name: "Creative Commons Attribution Non Commercial 3.0 Germany", - url: "https://creativecommons.org/licenses/by-nc/3.0/de/legalcode", - osiApproved: false, - }, - "Artistic-1.0-cl8": { - name: "Artistic License 1.0 w/clause 8", - url: "https://opensource.org/licenses/Artistic-1.0", - osiApproved: true, - }, - "W3C-19980720": { - name: "W3C Software Notice and License (1998-07-20)", - url: "http://www.w3.org/Consortium/Legal/copyright-software-19980720.html", - osiApproved: false, - }, - "HPND-merchantability-variant": { - name: "Historical Permission Notice and Disclaimer - merchantability variant", - url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/misc/fini.c;hb=HEAD", - osiApproved: false, - }, - Motosoto: { - name: "Motosoto License", - url: "https://opensource.org/licenses/Motosoto", - osiApproved: true, - }, - "OLDAP-1.1": { - name: "Open LDAP Public License v1.1", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=806557a5ad59804ef3a44d5abfbe91d706b0791f", - osiApproved: false, - }, - "HP-1989": { - name: "Hewlett-Packard 1989 License", - url: "https://github.com/bleargh45/Data-UUID/blob/master/LICENSE", - osiApproved: false, - }, - "IEC-Code-Components-EULA": { - name: "IEC Code Components End-user licence agreement", - url: "https://www.iec.ch/webstore/custserv/pdf/CC-EULA.pdf", - osiApproved: false, - }, - "NCGL-UK-2.0": { - name: "Non-Commercial Government Licence", - url: "http://www.nationalarchives.gov.uk/doc/non-commercial-government-licence/version/2/", - osiApproved: false, - }, - "CC-BY-3.0-IGO": { - name: "Creative Commons Attribution 3.0 IGO", - url: "https://creativecommons.org/licenses/by/3.0/igo/legalcode", - osiApproved: false, - }, - "BSD-Source-Code": { - name: "BSD Source Code Attribution", - url: "https://github.com/robbiehanson/CocoaHTTPServer/blob/master/LICENSE.txt", - osiApproved: false, - }, - "GFDL-1.1-no-invariants-only": { - name: "GNU Free Documentation License v1.1 only - no invariants", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", - osiApproved: false, - }, - W3C: { - name: "W3C Software Notice and License (2002-12-31)", - url: "http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231.html", - osiApproved: true, - }, - magaz: { - name: "magaz License", - url: "https://mirrors.nic.cz/tex-archive/macros/latex/contrib/magaz/magaz.tex", - osiApproved: false, - }, - "libutil-David-Nugent": { - name: "libutil David Nugent License", - url: "http://web.mit.edu/freebsd/head/lib/libutil/login_ok.3", - osiApproved: false, - }, - "AFL-2.1": { - name: "Academic Free License v2.1", - url: "http://opensource.linux-mirror.org/licenses/afl-2.1.txt", - osiApproved: true, - }, - "NAIST-2003": { - name: "Nara Institute of Science and Technology License (2003)", - url: "https://enterprise.dejacode.com/licenses/public/naist-2003/#license-text", - osiApproved: false, - }, - "DocBook-XML": { - name: "DocBook XML License", - url: "https://github.com/docbook/xslt10-stylesheets/blob/efd62655c11cc8773708df7a843613fa1e932bf8/xsl/COPYING#L27", - osiApproved: false, - }, - "LiLiQ-Rplus-1.1": { - name: "Licence Libre du Québec – Réciprocité forte version 1.1", - url: "https://www.forge.gouv.qc.ca/participez/licence-logicielle/licence-libre-du-quebec-liliq-en-francais/licence-libre-du-quebec-reciprocite-forte-liliq-r-v1-1/", - osiApproved: true, - }, - "MIT-feh": { - name: "feh License", - url: "https://fedoraproject.org/wiki/Licensing/MIT#feh", - osiApproved: false, - }, - "LGPL-2.1": { - name: "GNU Lesser General Public License v2.1 only", - url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", - osiApproved: true, - }, - "UMich-Merit": { - name: "Michigan/Merit Networks License", - url: "https://github.com/radcli/radcli/blob/master/COPYRIGHT#L64", - osiApproved: false, - }, - "CC-BY-NC-3.0": { - name: "Creative Commons Attribution Non Commercial 3.0 Unported", - url: "https://creativecommons.org/licenses/by-nc/3.0/legalcode", - osiApproved: false, - }, - "GPL-1.0": { - name: "GNU General Public License v1.0 only", - url: "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", - osiApproved: false, - }, - NTP: { - name: "NTP License", - url: "https://opensource.org/licenses/NTP", - osiApproved: true, - }, - "Frameworx-1.0": { - name: "Frameworx Open License 1.0", - url: "https://opensource.org/licenses/Frameworx-1.0", - osiApproved: true, - }, - "BSD-2-Clause-NetBSD": { - name: "BSD 2-Clause NetBSD License", - url: "http://www.netbsd.org/about/redistribution.html#default", - osiApproved: false, - }, - "HPND-sell-variant": { - name: "Historical Permission Notice and Disclaimer - sell variant", - url: "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/net/sunrpc/auth_gss/gss_generic_token.c?h=v4.19", - osiApproved: false, - }, - "CC-BY-1.0": { - name: "Creative Commons Attribution 1.0 Generic", - url: "https://creativecommons.org/licenses/by/1.0/legalcode", - osiApproved: false, - }, - "APL-1.0": { - name: "Adaptive Public License 1.0", - url: "https://opensource.org/licenses/APL-1.0", - osiApproved: true, - }, - WTFPL: { - name: "Do What The F*ck You Want To Public License", - url: "http://www.wtfpl.net/about/", - osiApproved: false, - }, - FBM: { - name: "Fuzzy Bitmap License", - url: "https://github.com/SWI-Prolog/packages-xpce/blob/161a40cd82004f731ba48024f9d30af388a7edf5/src/img/gifwrite.c#L21-L26", - osiApproved: false, - }, - ClArtistic: { - name: "Clarified Artistic License", - url: "http://gianluca.dellavedova.org/2011/01/03/clarified-artistic-license/", - osiApproved: false, - }, - SunPro: { - name: "SunPro License", - url: "https://github.com/freebsd/freebsd-src/blob/main/lib/msun/src/e_acosh.c", - osiApproved: false, - }, - "VSL-1.0": { - name: "Vovida Software License v1.0", - url: "https://opensource.org/licenses/VSL-1.0", - osiApproved: true, - }, - "CC-BY-NC-SA-3.0-IGO": { - name: "Creative Commons Attribution Non Commercial Share Alike 3.0 IGO", - url: "https://creativecommons.org/licenses/by-nc-sa/3.0/igo/legalcode", - osiApproved: false, - }, - "NBPL-1.0": { - name: "Net Boolean Public License v1", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=37b4b3f6cc4bf34e1d3dec61e69914b9819d8894", - osiApproved: false, - }, - "OPUBL-1.0": { - name: "Open Publication License v1.0", - url: "http://opencontent.org/openpub/", - osiApproved: false, - }, - "CC-BY-NC-ND-2.0": { - name: "Creative Commons Attribution Non Commercial No Derivatives 2.0 Generic", - url: "https://creativecommons.org/licenses/by-nc-nd/2.0/legalcode", - osiApproved: false, - }, - "BSD-3-Clause-LBNL": { - name: "Lawrence Berkeley National Labs BSD variant license", - url: "https://fedoraproject.org/wiki/Licensing/LBNLBSD", - osiApproved: true, - }, - Ruby: { - name: "Ruby License", - url: "https://www.ruby-lang.org/en/about/license.txt", - osiApproved: false, - }, - Fair: { - name: "Fair License", - url: "https://web.archive.org/web/20150926120323/http://fairlicense.org/", - osiApproved: true, - }, - "MIT-advertising": { - name: "Enlightenment License (e16)", - url: "https://fedoraproject.org/wiki/Licensing/MIT_With_Advertising", - osiApproved: false, - }, - "OGDL-Taiwan-1.0": { - name: "Taiwan Open Government Data License, version 1.0", - url: "https://data.gov.tw/license", - osiApproved: false, - }, - "OPL-UK-3.0": { - name: "United Kingdom Open Parliament Licence v3.0", - url: "https://www.parliament.uk/site-information/copyright-parliament/open-parliament-licence/", - osiApproved: false, - }, - "MPL-2.0": { - name: "Mozilla Public License 2.0", - url: "https://www.mozilla.org/MPL/2.0/", - osiApproved: true, - }, - "DocBook-Stylesheet": { - name: "DocBook Stylesheet License", - url: "http://www.docbook.org/xml/5.0/docbook-5.0.zip", - osiApproved: false, - }, - "TPL-1.0": { - name: "THOR Public License 1.0", - url: "https://fedoraproject.org/wiki/Licensing:ThorPublicLicense", - osiApproved: false, - }, - "TAPR-OHL-1.0": { - name: "TAPR Open Hardware License v1.0", - url: "https://www.tapr.org/OHL", - osiApproved: false, - }, - UnixCrypt: { - name: "UnixCrypt License", - url: "https://foss.heptapod.net/python-libs/passlib/-/blob/branch/stable/LICENSE#L70", - osiApproved: false, - }, - "FreeBSD-DOC": { - name: "FreeBSD Documentation License", - url: "https://www.freebsd.org/copyright/freebsd-doc-license/", - osiApproved: false, - }, - "CMU-Mach-nodoc": { - name: "CMU Mach - no notices-in-documentation variant", - url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L718-L728", - osiApproved: false, - }, - "CC-BY-3.0-AU": { - name: "Creative Commons Attribution 3.0 Australia", - url: "https://creativecommons.org/licenses/by/3.0/au/legalcode", - osiApproved: false, - }, - "Zimbra-1.4": { - name: "Zimbra Public License v1.4", - url: "http://www.zimbra.com/legal/zimbra-public-license-1-4", - osiApproved: false, - }, - "BSD-3-Clause": { - name: 'BSD 3-Clause "New" or "Revised" License', - url: "https://opensource.org/licenses/BSD-3-Clause", - osiApproved: true, - }, - lsof: { - name: "lsof License", - url: "https://github.com/lsof-org/lsof/blob/master/COPYING", - osiApproved: false, - }, - FreeImage: { - name: "FreeImage Public License v1.0", - url: "http://freeimage.sourceforge.net/freeimage-license.txt", - osiApproved: false, - }, - "OLDAP-2.0": { - name: "Open LDAP Public License v2.0 (or possibly 2.0A and 2.0B)", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=cbf50f4e1185a21abd4c0a54d3f4341fe28f36ea", - osiApproved: false, - }, - "APSL-1.2": { - name: "Apple Public Source License 1.2", - url: "http://www.samurajdata.se/opensource/mirror/licenses/apsl.php", - osiApproved: true, - }, - "APSL-1.0": { - name: "Apple Public Source License 1.0", - url: "https://fedoraproject.org/wiki/Licensing/Apple_Public_Source_License_1.0", - osiApproved: true, - }, - "CC-BY-NC-SA-2.0-FR": { - name: "Creative Commons Attribution-NonCommercial-ShareAlike 2.0 France", - url: "https://creativecommons.org/licenses/by-nc-sa/2.0/fr/legalcode", - osiApproved: false, - }, - "D-FSL-1.0": { - name: "Deutsche Freie Software Lizenz", - url: "http://www.dipp.nrw.de/d-fsl/lizenzen/", - osiApproved: false, - }, - pnmstitch: { - name: "pnmstitch License", - url: "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/editor/pnmstitch.c#l2", - osiApproved: false, - }, - "CC-BY-SA-2.0-UK": { - name: "Creative Commons Attribution Share Alike 2.0 England and Wales", - url: "https://creativecommons.org/licenses/by-sa/2.0/uk/legalcode", - osiApproved: false, - }, - "CERN-OHL-W-2.0": { - name: "CERN Open Hardware Licence Version 2 - Weakly Reciprocal", - url: "https://www.ohwr.org/project/cernohl/wikis/Documents/CERN-OHL-version-2", - osiApproved: true, - }, - "LPL-1.02": { - name: "Lucent Public License v1.02", - url: "http://plan9.bell-labs.com/plan9/license.html", - osiApproved: true, - }, - "CNRI-Jython": { - name: "CNRI Jython License", - url: "http://www.jython.org/license.html", - osiApproved: false, - }, - "BSD-2-Clause-first-lines": { - name: "BSD 2-Clause - first lines requirement", - url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L664-L690", - osiApproved: false, - }, - "BSL-1.0": { - name: "Boost Software License 1.0", - url: "http://www.boost.org/LICENSE_1_0.txt", - osiApproved: true, - }, - "LZMA-SDK-9.11-to-9.20": { - name: "LZMA SDK License (versions 9.11 to 9.20)", - url: "https://www.7-zip.org/sdk.html", - osiApproved: false, - }, - "Condor-1.1": { - name: "Condor Public License v1.1", - url: "http://research.cs.wisc.edu/condor/license.html#condor", - osiApproved: false, - }, - "CC-BY-3.0-US": { - name: "Creative Commons Attribution 3.0 United States", - url: "https://creativecommons.org/licenses/by/3.0/us/legalcode", - osiApproved: false, - }, - "CECILL-C": { - name: "CeCILL-C Free Software License Agreement", - url: "http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html", - osiApproved: false, - }, - diffmark: { - name: "diffmark license", - url: "https://fedoraproject.org/wiki/Licensing/diffmark", - osiApproved: false, - }, - "HPND-Kevlin-Henney": { - name: "Historical Permission Notice and Disclaimer - Kevlin Henney variant", - url: "https://github.com/mruby/mruby/blob/83d12f8d52522cdb7c8cc46fad34821359f453e6/mrbgems/mruby-dir/src/Win/dirent.c#L127-L140", - osiApproved: false, - }, - "GFDL-1.1": { - name: "GNU Free Documentation License v1.1", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", - osiApproved: false, - }, - "StandardML-NJ": { - name: "Standard ML of New Jersey License", - url: "https://www.smlnj.org/license.html", - osiApproved: false, - }, - "RPL-1.1": { - name: "Reciprocal Public License 1.1", - url: "https://opensource.org/licenses/RPL-1.1", - osiApproved: true, - }, - "Hippocratic-2.1": { - name: "Hippocratic License 2.1", - url: "https://firstdonoharm.dev/version/2/1/license.html", - osiApproved: false, - }, - swrule: { - name: "swrule License", - url: "https://ctan.math.utah.edu/ctan/tex-archive/macros/generic/misc/swrule.sty", - osiApproved: false, - }, - "CDDL-1.0": { - name: "Common Development and Distribution License 1.0", - url: "https://opensource.org/licenses/cddl1", - osiApproved: true, - }, - "MS-RL": { - name: "Microsoft Reciprocal License", - url: "http://www.microsoft.com/opensource/licenses.mspx", - osiApproved: true, - }, - "any-OSI-perl-modules": { - name: "Any OSI License - Perl Modules", - url: "https://metacpan.org/release/JUERD/Exporter-Tidy-0.09/view/Tidy.pm#LICENSE", - osiApproved: false, - }, - "CNRI-Python": { - name: "CNRI Python License", - url: "https://opensource.org/licenses/CNRI-Python", - osiApproved: true, - }, - "OLDAP-2.3": { - name: "Open LDAP Public License v2.3", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=d32cf54a32d581ab475d23c810b0a7fbaf8d63c3", - osiApproved: false, - }, - "LiLiQ-P-1.1": { - name: "Licence Libre du Québec – Permissive version 1.1", - url: "https://forge.gouv.qc.ca/licence/fr/liliq-v1-1/", - osiApproved: true, - }, - "Python-2.0.1": { - name: "Python License 2.0.1", - url: "https://www.python.org/download/releases/2.0.1/license/", - osiApproved: false, - }, - MakeIndex: { - name: "MakeIndex License", - url: "https://fedoraproject.org/wiki/Licensing/MakeIndex", - osiApproved: false, - }, - "AFL-1.2": { - name: "Academic Free License v1.2", - url: "http://opensource.linux-mirror.org/licenses/afl-1.2.txt", - osiApproved: true, - }, - "CC-BY-ND-2.0": { - name: "Creative Commons Attribution No Derivatives 2.0 Generic", - url: "https://creativecommons.org/licenses/by-nd/2.0/legalcode", - osiApproved: false, - }, - "FDK-AAC": { - name: "Fraunhofer FDK AAC Codec Library", - url: "https://fedoraproject.org/wiki/Licensing/FDK-AAC", - osiApproved: false, - }, - SL: { - name: "SL License", - url: "https://github.com/mtoyoda/sl/blob/master/LICENSE", - osiApproved: false, - }, - "TU-Berlin-1.0": { - name: "Technische Universitaet Berlin License 1.0", - url: "https://github.com/swh/ladspa/blob/7bf6f3799fdba70fda297c2d8fd9f526803d9680/gsm/COPYRIGHT", - osiApproved: false, - }, - "GPL-1.0+": { - name: "GNU General Public License v1.0 or later", - url: "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", - osiApproved: false, - }, - Saxpath: { - name: "Saxpath License", - url: "https://fedoraproject.org/wiki/Licensing/Saxpath_License", - osiApproved: false, - }, - dvipdfm: { - name: "dvipdfm License", - url: "https://fedoraproject.org/wiki/Licensing/dvipdfm", - osiApproved: false, - }, - "BSD-2-Clause-Darwin": { - name: "BSD 2-Clause - Ian Darwin variant", - url: "https://github.com/file/file/blob/master/COPYING", - osiApproved: false, - }, - "CPAL-1.0": { - name: "Common Public Attribution License 1.0", - url: "https://opensource.org/licenses/CPAL-1.0", - osiApproved: true, - }, - "copyleft-next-0.3.1": { - name: "copyleft-next 0.3.1", - url: "https://github.com/copyleft-next/copyleft-next/blob/master/Releases/copyleft-next-0.3.1", - osiApproved: false, - }, - NetCDF: { - name: "NetCDF license", - url: "http://www.unidata.ucar.edu/software/netcdf/copyright.html", - osiApproved: false, - }, - FTL: { - name: "Freetype Project License", - url: "http://freetype.fis.uniroma2.it/FTL.TXT", - osiApproved: false, - }, - "DocBook-Schema": { - name: "DocBook Schema License", - url: "https://github.com/docbook/xslt10-stylesheets/blob/efd62655c11cc8773708df7a843613fa1e932bf8/xsl/assembly/schema/docbook51b7.rnc", - osiApproved: false, - }, - "CERN-OHL-S-2.0": { - name: "CERN Open Hardware Licence Version 2 - Strongly Reciprocal", - url: "https://www.ohwr.org/project/cernohl/wikis/Documents/CERN-OHL-version-2", - osiApproved: true, - }, - "X11-distribute-modifications-variant": { - name: "X11 License Distribution Modification Variant", - url: "https://github.com/mirror/ncurses/blob/master/COPYING", - osiApproved: false, - }, - "copyleft-next-0.3.0": { - name: "copyleft-next 0.3.0", - url: "https://github.com/copyleft-next/copyleft-next/blob/master/Releases/copyleft-next-0.3.0", - osiApproved: false, - }, - X11: { - name: "X11 License", - url: "http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3", - osiApproved: false, - }, - "CC-BY-NC-SA-2.0-DE": { - name: "Creative Commons Attribution Non Commercial Share Alike 2.0 Germany", - url: "https://creativecommons.org/licenses/by-nc-sa/2.0/de/legalcode", - osiApproved: false, - }, - "GFDL-1.3-only": { - name: "GNU Free Documentation License v1.3 only", - url: "https://www.gnu.org/licenses/fdl-1.3.txt", - osiApproved: false, - }, - Bahyph: { - name: "Bahyph License", - url: "https://fedoraproject.org/wiki/Licensing/Bahyph", - osiApproved: false, - }, - "LGPL-3.0-or-later": { - name: "GNU Lesser General Public License v3.0 or later", - url: "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", - osiApproved: true, - }, - "ZPL-1.1": { - name: "Zope Public License 1.1", - url: "http://old.zope.org/Resources/License/ZPL-1.1", - osiApproved: false, - }, - "gSOAP-1.3b": { - name: "gSOAP Public License v1.3b", - url: "http://www.cs.fsu.edu/~engelen/license.html", - osiApproved: false, - }, - "JasPer-2.0": { - name: "JasPer License", - url: "http://www.ece.uvic.ca/~mdadams/jasper/LICENSE", - osiApproved: false, - }, - "Sendmail-Open-Source-1.1": { - name: "Sendmail Open Source License v1.1", - url: "https://github.com/trusteddomainproject/OpenDMARC/blob/master/LICENSE.Sendmail", - osiApproved: false, - }, - "BUSL-1.1": { - name: "Business Source License 1.1", - url: "https://mariadb.com/bsl11/", - osiApproved: false, - }, - Eurosym: { - name: "Eurosym License", - url: "https://fedoraproject.org/wiki/Licensing/Eurosym", - osiApproved: false, - }, - ThirdEye: { - name: "ThirdEye License", - url: "https://sourceware.org/cgit/binutils-gdb/tree/include/coff/symconst.h#n11", - osiApproved: false, - }, - "CC-SA-1.0": { - name: "Creative Commons Share Alike 1.0 Generic", - url: "https://creativecommons.org/licenses/sa/1.0/legalcode", - osiApproved: false, - }, - "Watcom-1.0": { - name: "Sybase Open Watcom Public License 1.0", - url: "https://opensource.org/licenses/Watcom-1.0", - osiApproved: true, - }, - Caldera: { - name: "Caldera License", - url: "http://www.lemis.com/grog/UNIX/ancient-source-all.pdf", - osiApproved: false, - }, - "Parity-7.0.0": { - name: "The Parity Public License 7.0.0", - url: "https://paritylicense.com/versions/7.0.0.html", - osiApproved: false, - }, - SMPPL: { - name: "Secure Messaging Protocol Public License", - url: "https://github.com/dcblake/SMP/blob/master/Documentation/License.txt", - osiApproved: false, - }, - "AGPL-1.0": { - name: "Affero General Public License v1.0", - url: "http://www.affero.org/oagpl.html", - osiApproved: false, - }, - "MulanPSL-2.0": { - name: "Mulan Permissive Software License, Version 2", - url: "https://license.coscl.org.cn/MulanPSL2", - osiApproved: true, - }, - Afmparse: { - name: "Afmparse License", - url: "https://fedoraproject.org/wiki/Licensing/Afmparse", - osiApproved: false, - }, - "GFDL-1.2-no-invariants-or-later": { - name: "GNU Free Documentation License v1.2 or later - no invariants", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", - osiApproved: false, - }, - "Lucida-Bitmap-Fonts": { - name: "Lucida Bitmap Fonts License", - url: "https://gitlab.freedesktop.org/xorg/font/bh-100dpi/-/blob/master/COPYING?ref_type=heads", - osiApproved: false, - }, - "DRL-1.0": { - name: "Detection Rule License 1.0", - url: "https://github.com/Neo23x0/sigma/blob/master/LICENSE.Detection.Rules.md", - osiApproved: false, - }, - "CC-BY-NC-2.5": { - name: "Creative Commons Attribution Non Commercial 2.5 Generic", - url: "https://creativecommons.org/licenses/by-nc/2.5/legalcode", - osiApproved: false, - }, - GD: { - name: "GD License", - url: "https://libgd.github.io/manuals/2.3.0/files/license-txt.html", - osiApproved: false, - }, - "Zend-2.0": { - name: "Zend License v2.0", - url: "https://web.archive.org/web/20130517195954/http://www.zend.com/license/2_00.txt", - osiApproved: false, - }, - Cronyx: { - name: "Cronyx License", - url: "https://gitlab.freedesktop.org/xorg/font/alias/-/blob/master/COPYING", - osiApproved: false, - }, - TTYP0: { - name: "TTYP0 License", - url: "https://people.mpi-inf.mpg.de/~uwe/misc/uw-ttyp0/", - osiApproved: false, - }, - "CC-BY-ND-1.0": { - name: "Creative Commons Attribution No Derivatives 1.0 Generic", - url: "https://creativecommons.org/licenses/by-nd/1.0/legalcode", - osiApproved: false, - }, - "Ferguson-Twofish": { - name: "Ferguson Twofish License", - url: "https://github.com/wernerd/ZRTPCPP/blob/6b3cd8e6783642292bad0c21e3e5e5ce45ff3e03/cryptcommon/twofish.c#L113C3-L127", - osiApproved: false, - }, - SchemeReport: { - name: "Scheme Language Report License", - osiApproved: false, - }, - "MIT-Khronos-old": { - name: "MIT Khronos - old variant", - url: "https://github.com/KhronosGroup/SPIRV-Cross/blob/main/LICENSES/LicenseRef-KhronosFreeUse.txt", - osiApproved: false, - }, - "LPD-document": { - name: "LPD Documentation License", - url: "https://github.com/Cyan4973/xxHash/blob/dev/doc/xxhash_spec.md", - osiApproved: false, - }, - "UPL-1.0": { - name: "Universal Permissive License v1.0", - url: "https://opensource.org/licenses/UPL", - osiApproved: true, - }, - "CECILL-1.1": { - name: "CeCILL Free Software License Agreement v1.1", - url: "http://www.cecill.info/licences/Licence_CeCILL_V1.1-US.html", - osiApproved: false, - }, - Crossword: { - name: "Crossword License", - url: "https://fedoraproject.org/wiki/Licensing/Crossword", - osiApproved: false, - }, - "C-UDA-1.0": { - name: "Computational Use of Data Agreement v1.0", - url: "https://github.com/microsoft/Computational-Use-of-Data-Agreement/blob/master/C-UDA-1.0.md", - osiApproved: false, - }, - "BSD-3-Clause-HP": { - name: "Hewlett-Packard BSD variant license", - url: "https://github.com/zdohnal/hplip/blob/master/COPYING#L939", - osiApproved: false, - }, - "Apache-1.0": { - name: "Apache License 1.0", - url: "http://www.apache.org/licenses/LICENSE-1.0", - osiApproved: false, - }, - "CERN-OHL-1.1": { - name: "CERN Open Hardware Licence v1.1", - url: "https://www.ohwr.org/project/licenses/wikis/cern-ohl-v1.1", - osiApproved: false, - }, - SISSL: { - name: "Sun Industry Standards Source License v1.1", - url: "http://www.openoffice.org/licenses/sissl_license.html", - osiApproved: true, - }, - "MPL-2.0-no-copyleft-exception": { - name: "Mozilla Public License 2.0 (no copyleft exception)", - url: "https://www.mozilla.org/MPL/2.0/", - osiApproved: true, - }, - "OLFL-1.3": { - name: "Open Logistics Foundation License Version 1.3", - url: "https://openlogisticsfoundation.org/licenses/", - osiApproved: true, - }, - "Inner-Net-2.0": { - name: "Inner Net License v2.0", - url: "https://fedoraproject.org/wiki/Licensing/Inner_Net_License", - osiApproved: false, - }, - "GPL-1.0-only": { - name: "GNU General Public License v1.0 only", - url: "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", - osiApproved: false, - }, - "LiLiQ-R-1.1": { - name: "Licence Libre du Québec – Réciprocité version 1.1", - url: "https://www.forge.gouv.qc.ca/participez/licence-logicielle/licence-libre-du-quebec-liliq-en-francais/licence-libre-du-quebec-reciprocite-liliq-r-v1-1/", - osiApproved: true, - }, - "BSD-4.3TAHOE": { - name: "BSD 4.3 TAHOE License", - url: "https://github.com/389ds/389-ds-base/blob/main/ldap/include/sysexits-compat.h#L15", - osiApproved: false, - }, - "AFL-2.0": { - name: "Academic Free License v2.0", - url: "http://wayback.archive.org/web/20060924134533/http://www.opensource.org/licenses/afl-2.0.txt", - osiApproved: true, - }, - "GFDL-1.2-invariants-or-later": { - name: "GNU Free Documentation License v1.2 or later - invariants", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", - osiApproved: false, - }, - "CC-BY-NC-ND-2.5": { - name: "Creative Commons Attribution Non Commercial No Derivatives 2.5 Generic", - url: "https://creativecommons.org/licenses/by-nc-nd/2.5/legalcode", - osiApproved: false, - }, - "OLDAP-2.4": { - name: "Open LDAP Public License v2.4", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=cd1284c4a91a8a380d904eee68d1583f989ed386", - osiApproved: false, - }, - "Brian-Gladman-3-Clause": { - name: "Brian Gladman 3-Clause License", - url: "https://github.com/SWI-Prolog/packages-clib/blob/master/sha1/brg_endian.h", - osiApproved: false, - }, - gtkbook: { - name: "gtkbook License", - url: "https://github.com/slogan621/gtkbook", - osiApproved: false, - }, - "OFL-1.0-no-RFN": { - name: "SIL Open Font License 1.0 with no Reserved Font Name", - url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL10_web", - osiApproved: false, - }, - "LAL-1.3": { - name: "Licence Art Libre 1.3", - url: "https://artlibre.org/", - osiApproved: false, - }, - threeparttable: { - name: "threeparttable License", - url: "https://fedoraproject.org/wiki/Licensing/Threeparttable", - osiApproved: false, - }, - Imlib2: { - name: "Imlib2 License", - url: "http://trac.enlightenment.org/e/browser/trunk/imlib2/COPYING", - osiApproved: false, - }, - "Adobe-Display-PostScript": { - name: "Adobe Display PostScript License", - url: "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L752", - osiApproved: false, - }, - Xnet: { - name: "X.Net License", - url: "https://opensource.org/licenses/Xnet", - osiApproved: true, - }, - "OSL-2.1": { - name: "Open Software License 2.1", - url: "http://web.archive.org/web/20050212003940/http://www.rosenlaw.com/osl21.htm", - osiApproved: true, - }, - "OLDAP-2.2": { - name: "Open LDAP Public License v2.2", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=470b0c18ec67621c85881b2733057fecf4a1acc3", - osiApproved: false, - }, - "MS-LPL": { - name: "Microsoft Limited Public License", - url: "https://www.openhub.net/licenses/mslpl", - osiApproved: false, - }, - Mup: { - name: "Mup License", - url: "https://fedoraproject.org/wiki/Licensing/Mup", - osiApproved: false, - }, - "LGPL-3.0": { - name: "GNU Lesser General Public License v3.0 only", - url: "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", - osiApproved: true, - }, - "BSD-4.3RENO": { - name: "BSD 4.3 RENO License", - url: "https://sourceware.org/git/?p=binutils-gdb.git;a=blob;f=libiberty/strcasecmp.c;h=131d81c2ce7881fa48c363dc5bf5fb302c61ce0b;hb=HEAD", - osiApproved: false, - }, - "MIT-Click": { - name: "MIT Click License", - url: "https://github.com/kohler/t1utils/blob/master/LICENSE", - osiApproved: false, - }, - "W3C-20150513": { - name: "W3C Software Notice and Document License (2015-05-13)", - url: "https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document", - osiApproved: true, - }, - "GPL-1.0-or-later": { - name: "GNU General Public License v1.0 or later", - url: "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", - osiApproved: false, - }, - "OSL-2.0": { - name: "Open Software License 2.0", - url: "http://web.archive.org/web/20041020171434/http://www.rosenlaw.com/osl2.0.html", - osiApproved: true, - }, - "EPL-2.0": { - name: "Eclipse Public License 2.0", - url: "https://www.eclipse.org/legal/epl-2.0", - osiApproved: true, - }, - "GFDL-1.3": { - name: "GNU Free Documentation License v1.3", - url: "https://www.gnu.org/licenses/fdl-1.3.txt", - osiApproved: false, - }, - "ASWF-Digital-Assets-1.0": { - name: "ASWF Digital Assets License version 1.0", - url: "https://github.com/AcademySoftwareFoundation/foundation/blob/main/digital_assets/aswf_digital_assets_license_v1.0.txt", - osiApproved: false, - }, - "APSL-1.1": { - name: "Apple Public Source License 1.1", - url: "http://www.opensource.apple.com/source/IOSerialFamily/IOSerialFamily-7/APPLE_LICENSE", - osiApproved: true, - }, - HPND: { - name: "Historical Permission Notice and Disclaimer", - url: "https://opensource.org/licenses/HPND", - osiApproved: true, - }, - "Linux-OpenIB": { - name: "Linux Kernel Variant of OpenIB.org license", - url: "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/infiniband/core/sa.h", - osiApproved: false, - }, - Zeeff: { - name: "Zeeff License", - url: "ftp://ftp.tin.org/pub/news/utils/newsx/newsx-1.6.tar.gz", - osiApproved: false, - }, - "OGL-UK-3.0": { - name: "Open Government Licence v3.0", - url: "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/", - osiApproved: false, - }, - "CC-BY-ND-3.0-DE": { - name: "Creative Commons Attribution No Derivatives 3.0 Germany", - url: "https://creativecommons.org/licenses/by-nd/3.0/de/legalcode", - osiApproved: false, - }, - "BSD-4-Clause-Shortened": { - name: "BSD 4 Clause Shortened", - url: "https://metadata.ftp-master.debian.org/changelogs//main/a/arpwatch/arpwatch_2.1a15-7_copyright", - osiApproved: false, - }, - "BSD-2-Clause-FreeBSD": { - name: "BSD 2-Clause FreeBSD License", - url: "http://www.freebsd.org/copyright/freebsd-license.html", - osiApproved: false, - }, - gnuplot: { - name: "gnuplot License", - url: "https://fedoraproject.org/wiki/Licensing/Gnuplot", - osiApproved: false, - }, - "libpng-2.0": { - name: "PNG Reference Library version 2", - url: "http://www.libpng.org/pub/png/src/libpng-LICENSE.txt", - osiApproved: false, - }, - Leptonica: { - name: "Leptonica License", - url: "https://fedoraproject.org/wiki/Licensing/Leptonica", - osiApproved: false, - }, - Clips: { - name: "Clips License", - url: "https://github.com/DrItanium/maya/blob/master/LICENSE.CLIPS", - osiApproved: false, - }, - OpenSSL: { - name: "OpenSSL License", - url: "http://www.openssl.org/source/license.html", - osiApproved: false, - }, - Sendmail: { - name: "Sendmail License", - url: "http://www.sendmail.com/pdfs/open_source/sendmail_license.pdf", - osiApproved: false, - }, - "NCBI-PD": { - name: "NCBI Public Domain Notice", - url: "https://github.com/ncbi/sra-tools/blob/e8e5b6af4edc460156ad9ce5902d0779cffbf685/LICENSE", - osiApproved: false, - }, - TrustedQSL: { - name: "TrustedQSL License", - url: "https://sourceforge.net/p/trustedqsl/tqsl/ci/master/tree/LICENSE.txt", - osiApproved: false, - }, - Catharon: { - name: "Catharon License", - url: "https://github.com/scummvm/scummvm/blob/v2.8.0/LICENSES/CatharonLicense.txt", - osiApproved: false, - }, - "EUPL-1.2": { - name: "European Union Public License 1.2", - url: "https://joinup.ec.europa.eu/page/eupl-text-11-12", - osiApproved: true, - }, - Wsuipa: { - name: "Wsuipa License", - url: "https://fedoraproject.org/wiki/Licensing/Wsuipa", - osiApproved: false, - }, - "OGL-UK-2.0": { - name: "Open Government Licence v2.0", - url: "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/2/", - osiApproved: false, - }, - "ISC-Veillard": { - name: "ISC Veillard variant", - url: "https://raw.githubusercontent.com/GNOME/libxml2/4c2e7c651f6c2f0d1a74f350cbda95f7df3e7017/hash.c", - osiApproved: false, - }, - "CC-BY-3.0-NL": { - name: "Creative Commons Attribution 3.0 Netherlands", - url: "https://creativecommons.org/licenses/by/3.0/nl/legalcode", - osiApproved: false, - }, - "AdaCore-doc": { - name: "AdaCore Doc License", - url: "https://github.com/AdaCore/xmlada/blob/master/docs/index.rst", - osiApproved: false, - }, - "AGPL-1.0-only": { - name: "Affero General Public License v1.0 only", - url: "http://www.affero.org/oagpl.html", - osiApproved: false, - }, - "LGPL-3.0+": { - name: "GNU Lesser General Public License v3.0 or later", - url: "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", - osiApproved: true, - }, - "libselinux-1.0": { - name: "libselinux public domain notice", - url: "https://github.com/SELinuxProject/selinux/blob/master/libselinux/LICENSE", - osiApproved: false, - }, - "HPND-Fenneberg-Livingston": { - name: "Historical Permission Notice and Disclaimer - Fenneberg-Livingston variant", - url: "https://github.com/FreeRADIUS/freeradius-client/blob/master/COPYRIGHT#L32", - osiApproved: false, - }, - "Xdebug-1.03": { - name: "Xdebug License v 1.03", - url: "https://github.com/xdebug/xdebug/blob/master/LICENSE", - osiApproved: false, - }, - Jam: { - name: "Jam License", - url: "https://www.boost.org/doc/libs/1_35_0/doc/html/jam.html", - osiApproved: true, - }, - "GPL-2.0-with-classpath-exception": { - name: "GNU General Public License v2.0 w/Classpath exception", - url: "https://www.gnu.org/software/classpath/license.html", - osiApproved: false, - }, - "check-cvs": { - name: "check-cvs License", - url: "http://cvs.savannah.gnu.org/viewvc/cvs/ccvs/contrib/check_cvs.in?revision=1.1.4.3&view=markup&pathrev=cvs1-11-23#l2", - osiApproved: false, - }, - "LGPL-2.0+": { - name: "GNU Library General Public License v2 or later", - url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", - osiApproved: true, - }, - "AMD-newlib": { - name: "AMD newlib License", - url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/sys/a29khif/_close.S;h=04f52ae00de1dafbd9055ad8d73c5c697a3aae7f;hb=HEAD", - osiApproved: false, - }, - "CC-BY-NC-1.0": { - name: "Creative Commons Attribution Non Commercial 1.0 Generic", - url: "https://creativecommons.org/licenses/by-nc/1.0/legalcode", - osiApproved: false, - }, - xinetd: { - name: "xinetd License", - url: "https://fedoraproject.org/wiki/Licensing/Xinetd_License", - osiApproved: false, - }, - "BSD-4-Clause": { - name: 'BSD 4-Clause "Original" or "Old" License', - url: "http://directory.fsf.org/wiki/License:BSD_4Clause", - osiApproved: false, - }, - "IBM-pibs": { - name: "IBM PowerPC Initialization and Boot Software", - url: "http://git.denx.de/?p=u-boot.git;a=blob;f=arch/powerpc/cpu/ppc4xx/miiphy.c;h=297155fdafa064b955e53e9832de93bfb0cfb85b;hb=9fab4bf4cc077c21e43941866f3f2c196f28670d", - osiApproved: false, - }, - "Apache-2.0": { - name: "Apache License 2.0", - url: "https://www.apache.org/licenses/LICENSE-2.0", - osiApproved: true, - }, - "Linux-man-pages-1-para": { - name: "Linux man-pages - 1 paragraph", - url: "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/getcpu.2#n4", - osiApproved: false, - }, - "CPOL-1.02": { - name: "Code Project Open License 1.02", - url: "http://www.codeproject.com/info/cpol10.aspx", - osiApproved: false, - }, - "BSD-Source-beginning-file": { - name: "BSD Source Code Attribution - beginning of file variant", - url: "https://github.com/lattera/freebsd/blob/master/sys/cam/cam.c#L4", - osiApproved: false, - }, - "CERN-OHL-P-2.0": { - name: "CERN Open Hardware Licence Version 2 - Permissive", - url: "https://www.ohwr.org/project/cernohl/wikis/Documents/CERN-OHL-version-2", - osiApproved: true, - }, - OFFIS: { - name: "OFFIS License", - url: "https://sourceforge.net/p/xmedcon/code/ci/master/tree/libs/dicom/README", - osiApproved: false, - }, - "GPL-2.0-or-later": { - name: "GNU General Public License v2.0 or later", - url: "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", - osiApproved: true, - }, - radvd: { - name: "radvd License", - url: "https://github.com/radvd-project/radvd/blob/master/COPYRIGHT", - osiApproved: false, - }, - Xfig: { - name: "Xfig License", - url: "https://github.com/Distrotech/transfig/blob/master/transfig/transfig.c", - osiApproved: false, - }, - Multics: { - name: "Multics License", - url: "https://opensource.org/licenses/Multics", - osiApproved: true, - }, - "AFL-1.1": { - name: "Academic Free License v1.1", - url: "http://opensource.linux-mirror.org/licenses/afl-1.1.txt", - osiApproved: true, - }, - Beerware: { - name: "Beerware License", - url: "https://fedoraproject.org/wiki/Licensing/Beerware", - osiApproved: false, - }, - "MS-PL": { - name: "Microsoft Public License", - url: "http://www.microsoft.com/opensource/licenses.mspx", - osiApproved: true, - }, - "ssh-keyscan": { - name: "ssh-keyscan License", - url: "https://github.com/openssh/openssh-portable/blob/master/LICENCE#L82", - osiApproved: false, - }, - "Spencer-99": { - name: "Spencer License 99", - url: "http://www.opensource.apple.com/source/tcl/tcl-5/tcl/generic/regfronts.c", - osiApproved: false, - }, - "OFL-1.1": { - name: "SIL Open Font License 1.1", - url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web", - osiApproved: true, - }, - Baekmuk: { - name: "Baekmuk License", - url: "https://fedoraproject.org/wiki/Licensing:Baekmuk?rd=Licensing/Baekmuk", - osiApproved: false, - }, - Qhull: { - name: "Qhull License", - url: "https://fedoraproject.org/wiki/Licensing/Qhull", - osiApproved: false, - }, - "GFDL-1.2-or-later": { - name: "GNU Free Documentation License v1.2 or later", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", - osiApproved: false, - }, - "CC-BY-NC-SA-4.0": { - name: "Creative Commons Attribution Non Commercial Share Alike 4.0 International", - url: "https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode", - osiApproved: false, - }, - "APSL-2.0": { - name: "Apple Public Source License 2.0", - url: "http://www.opensource.apple.com/license/apsl/", - osiApproved: true, - }, - VOSTROM: { - name: "VOSTROM Public License for Open Source", - url: "https://fedoraproject.org/wiki/Licensing/VOSTROM", - osiApproved: false, - }, - "Net-SNMP": { - name: "Net-SNMP License", - url: "http://net-snmp.sourceforge.net/about/license.html", - osiApproved: false, - }, - "HPND-doc": { - name: "Historical Permission Notice and Disclaimer - documentation variant", - url: "https://gitlab.freedesktop.org/xorg/lib/libxext/-/blob/master/COPYING?ref_type=heads#L185-197", - osiApproved: false, - }, - NRL: { - name: "NRL License", - url: "http://web.mit.edu/network/isakmp/nrllicense.html", - osiApproved: false, - }, - TPDL: { - name: "Time::ParseDate License", - url: "https://metacpan.org/pod/Time::ParseDate#LICENSE", - osiApproved: false, - }, - "AGPL-1.0-or-later": { - name: "Affero General Public License v1.0 or later", - url: "http://www.affero.org/oagpl.html", - osiApproved: false, - }, - "HPND-Markus-Kuhn": { - name: "Historical Permission Notice and Disclaimer - Markus Kuhn variant", - url: "https://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c", - osiApproved: false, - }, - "LZMA-SDK-9.22": { - name: "LZMA SDK License (versions 9.22 and beyond)", - url: "https://www.7-zip.org/sdk.html", - osiApproved: false, - }, - "Unicode-3.0": { - name: "Unicode License v3", - url: "https://www.unicode.org/license.txt", - osiApproved: true, - }, - "GPL-3.0-or-later": { - name: "GNU General Public License v3.0 or later", - url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html", - osiApproved: true, - }, - "OpenSSL-standalone": { - name: "OpenSSL License - standalone", - url: "https://library.netapp.com/ecm/ecm_download_file/ECMP1196395", - osiApproved: false, - }, - "Zimbra-1.3": { - name: "Zimbra Public License v1.3", - url: "http://web.archive.org/web/20100302225219/http://www.zimbra.com/license/zimbra-public-license-1-3.html", - osiApproved: false, - }, - "xkeyboard-config-Zinoviev": { - name: "xkeyboard-config Zinoviev License", - url: "https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/blob/master/COPYING?ref_type=heads#L178", - osiApproved: false, - }, - "GFDL-1.1-invariants-only": { - name: "GNU Free Documentation License v1.1 only - invariants", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", - osiApproved: false, - }, - OML: { - name: "Open Market License", - url: "https://fedoraproject.org/wiki/Licensing/Open_Market_License", - osiApproved: false, - }, - "ANTLR-PD": { - name: "ANTLR Software Rights Notice", - url: "http://www.antlr2.org/license.html", - osiApproved: false, - }, - "HPND-MIT-disclaimer": { - name: "Historical Permission Notice and Disclaimer with MIT disclaimer", - url: "https://metacpan.org/release/NLNETLABS/Net-DNS-SEC-1.22/source/LICENSE", - osiApproved: false, - }, - Dotseqn: { - name: "Dotseqn License", - url: "https://fedoraproject.org/wiki/Licensing/Dotseqn", - osiApproved: false, - }, - "HPND-DEC": { - name: "Historical Permission Notice and Disclaimer - DEC variant", - url: "https://gitlab.freedesktop.org/xorg/app/xkbcomp/-/blob/master/COPYING?ref_type=heads#L69", - osiApproved: false, - }, - "LGPL-2.0-only": { - name: "GNU Library General Public License v2 only", - url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", - osiApproved: true, - }, - "CC-BY-2.5-AU": { - name: "Creative Commons Attribution 2.5 Australia", - url: "https://creativecommons.org/licenses/by/2.5/au/legalcode", - osiApproved: false, - }, - "DEC-3-Clause": { - name: "DEC 3-Clause License", - url: "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L239", - osiApproved: false, - }, - "QPL-1.0-INRIA-2004": { - name: "Q Public License 1.0 - INRIA 2004 variant", - url: "https://github.com/maranget/hevea/blob/master/LICENSE", - osiApproved: false, - }, - Intel: { - name: "Intel Open Source License", - url: "https://opensource.org/licenses/Intel", - osiApproved: true, - }, - "NIST-PD-fallback": { - name: "NIST Public Domain Notice with license fallback", - url: "https://github.com/usnistgov/jsip/blob/59700e6926cbe96c5cdae897d9a7d2656b42abe3/LICENSE", - osiApproved: false, - }, - "CC-BY-NC-4.0": { - name: "Creative Commons Attribution Non Commercial 4.0 International", - url: "https://creativecommons.org/licenses/by-nc/4.0/legalcode", - osiApproved: false, - }, - "BSD-3-Clause-No-Nuclear-Warranty": { - name: "BSD 3-Clause No Nuclear Warranty", - url: "https://jogamp.org/git/?p=gluegen.git;a=blob_plain;f=LICENSE.txt", - osiApproved: false, - }, - "HPND-UC": { - name: "Historical Permission Notice and Disclaimer - University of California variant", - url: "https://core.tcl-lang.org/tk/file?name=compat/unistd.h", - osiApproved: false, - }, - "MIT-Wu": { - name: "MIT Tom Wu Variant", - url: "https://github.com/chromium/octane/blob/master/crypto.js", - osiApproved: false, - }, - Kastrup: { - name: "Kastrup License", - url: "https://ctan.math.utah.edu/ctan/tex-archive/macros/generic/kastrup/binhex.dtx", - osiApproved: false, - }, - "MIT-CMU": { - name: "CMU License", - url: "https://fedoraproject.org/wiki/Licensing:MIT?rd=Licensing/MIT#CMU_Style", - osiApproved: false, - }, - "DL-DE-ZERO-2.0": { - name: "Data licence Germany – zero – version 2.0", - url: "https://www.govdata.de/dl-de/zero-2-0", - osiApproved: false, - }, - "NIST-Software": { - name: "NIST Software License", - url: "https://github.com/open-quantum-safe/liboqs/blob/40b01fdbb270f8614fde30e65d30e9da18c02393/src/common/rand/rand_nist.c#L1-L15", - osiApproved: false, - }, - "Spencer-94": { - name: "Spencer License 94", - url: "https://fedoraproject.org/wiki/Licensing/Henry_Spencer_Reg-Ex_Library_License", - osiApproved: false, - }, - "CC-BY-2.0": { - name: "Creative Commons Attribution 2.0 Generic", - url: "https://creativecommons.org/licenses/by/2.0/legalcode", - osiApproved: false, - }, - "EUPL-1.1": { - name: "European Union Public License 1.1", - url: "https://joinup.ec.europa.eu/software/page/eupl/licence-eupl", - osiApproved: true, - }, - "HPND-export-US-modify": { - name: "HPND with US Government export control warning and modification rqmt", - url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L1157-L1182", - osiApproved: false, - }, - "generic-xts": { - name: "Generic XTS License", - url: "https://github.com/mhogomchungu/zuluCrypt/blob/master/external_libraries/tcplay/generic_xts.c", - osiApproved: false, - }, - NLPL: { - name: "No Limit Public License", - url: "https://fedoraproject.org/wiki/Licensing/NLPL", - osiApproved: false, - }, - NCSA: { - name: "University of Illinois/NCSA Open Source License", - url: "http://otm.illinois.edu/uiuc_openSource", - osiApproved: true, - }, - "PSF-2.0": { - name: "Python Software Foundation License 2.0", - url: "https://opensource.org/licenses/Python-2.0", - osiApproved: false, - }, - "Linux-man-pages-copyleft-var": { - name: "Linux man-pages Copyleft Variant", - url: "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/set_mempolicy.2#n5", - osiApproved: false, - }, - "OSL-1.1": { - name: "Open Software License 1.1", - url: "https://fedoraproject.org/wiki/Licensing/OSL1.1", - osiApproved: false, - }, - "mpi-permissive": { - name: "mpi Permissive License", - url: "https://sources.debian.org/src/openmpi/4.1.0-10/ompi/debuggers/msgq_interface.h/?hl=19#L19", - osiApproved: false, - }, - Glulxe: { - name: "Glulxe License", - url: "https://fedoraproject.org/wiki/Licensing/Glulxe", - osiApproved: false, - }, - "LAL-1.2": { - name: "Licence Art Libre 1.2", - url: "http://artlibre.org/licence/lal/licence-art-libre-12/", - osiApproved: false, - }, - "SMAIL-GPL": { - name: "SMAIL General Public License", - url: "https://sources.debian.org/copyright/license/debianutils/4.11.2/", - osiApproved: false, - }, - "NASA-1.3": { - name: "NASA Open Source Agreement 1.3", - url: "http://ti.arc.nasa.gov/opensource/nosa/", - osiApproved: true, - }, - "SPL-1.0": { - name: "Sun Public License v1.0", - url: "https://opensource.org/licenses/SPL-1.0", - osiApproved: true, - }, - "BSD-Advertising-Acknowledgement": { - name: "BSD Advertising Acknowledgement License", - url: "https://github.com/python-excel/xlrd/blob/master/LICENSE#L33", - osiApproved: false, - }, - "BSD-3-Clause-Modification": { - name: "BSD 3-Clause Modification", - url: "https://fedoraproject.org/wiki/Licensing:BSD#Modification_Variant", - osiApproved: false, - }, - "3D-Slicer-1.0": { - name: "3D Slicer License v1.0", - url: "https://slicer.org/LICENSE", - osiApproved: false, - }, - "NPL-1.1": { - name: "Netscape Public License v1.1", - url: "http://www.mozilla.org/MPL/NPL/1.1/", - osiApproved: false, - }, - "GPL-2.0-with-GCC-exception": { - name: "GNU General Public License v2.0 w/GCC Runtime Library exception", - url: "https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=gcc/libgcc1.c;h=762f5143fc6eed57b6797c82710f3538aa52b40b;hb=cb143a3ce4fb417c68f5fa2691a1b1b1053dfba9#l10", - osiApproved: false, - }, - "IJG-short": { - name: "Independent JPEG Group License - short", - url: "https://sourceforge.net/p/xmedcon/code/ci/master/tree/libs/ljpg/", - osiApproved: false, - }, - "CC-BY-4.0": { - name: "Creative Commons Attribution 4.0 International", - url: "https://creativecommons.org/licenses/by/4.0/legalcode", - osiApproved: false, - }, - ulem: { - name: "ulem License", - url: "https://mirrors.ctan.org/macros/latex/contrib/ulem/README", - osiApproved: false, - }, - "BSD-3-Clause-Sun": { - name: "BSD 3-Clause Sun Microsystems", - url: "https://github.com/xmlark/msv/blob/b9316e2f2270bc1606952ea4939ec87fbba157f3/xsdlib/src/main/java/com/sun/msv/datatype/regexp/InternalImpl.java", - osiApproved: false, - }, - "SAX-PD-2.0": { - name: "Sax Public Domain Notice 2.0", - url: "http://www.saxproject.org/copying.html", - osiApproved: false, - }, - "TORQUE-1.1": { - name: "TORQUE v2.5+ Software License v1.1", - url: "https://fedoraproject.org/wiki/Licensing/TORQUEv1.1", - osiApproved: false, - }, - "TU-Berlin-2.0": { - name: "Technische Universitaet Berlin License 2.0", - url: "https://github.com/CorsixTH/deps/blob/fd339a9f526d1d9c9f01ccf39e438a015da50035/licences/libgsm.txt", - osiApproved: false, - }, - Borceux: { - name: "Borceux license", - url: "https://fedoraproject.org/wiki/Licensing/Borceux", - osiApproved: false, - }, - "GPL-3.0+": { - name: "GNU General Public License v3.0 or later", - url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html", - osiApproved: true, - }, - "0BSD": { - name: "BSD Zero Clause License", - url: "http://landley.net/toybox/license.html", - osiApproved: true, - }, - "Mackerras-3-Clause": { - name: "Mackerras 3-Clause License", - url: "https://github.com/ppp-project/ppp/blob/master/pppd/chap_ms.c#L6-L28", - osiApproved: false, - }, - "GFDL-1.3-invariants-or-later": { - name: "GNU Free Documentation License v1.3 or later - invariants", - url: "https://www.gnu.org/licenses/fdl-1.3.txt", - osiApproved: false, - }, - "Knuth-CTAN": { - name: "Knuth CTAN License", - url: "https://ctan.org/license/knuth", - osiApproved: false, - }, - SMLNJ: { - name: "Standard ML of New Jersey License", - url: "https://www.smlnj.org/license.html", - osiApproved: false, - }, - "NPOSL-3.0": { - name: "Non-Profit Open Software License 3.0", - url: "https://opensource.org/licenses/NOSL3.0", - osiApproved: true, - }, - "OLDAP-1.4": { - name: "Open LDAP Public License v1.4", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=c9f95c2f3f2ffb5e0ae55fe7388af75547660941", - osiApproved: false, - }, - "Intel-ACPI": { - name: "Intel ACPI Software License Agreement", - url: "https://fedoraproject.org/wiki/Licensing/Intel_ACPI_Software_License_Agreement", - osiApproved: false, - }, - "Adobe-Glyph": { - name: "Adobe Glyph List License", - url: "https://fedoraproject.org/wiki/Licensing/MIT#AdobeGlyph", - osiApproved: false, - }, - "BSD-3-Clause-Attribution": { - name: "BSD with attribution", - url: "https://fedoraproject.org/wiki/Licensing/BSD_with_Attribution", - osiApproved: false, - }, - metamail: { - name: "metamail License", - url: "https://github.com/Dual-Life/mime-base64/blob/master/Base64.xs#L12", - osiApproved: false, - }, - Zed: { - name: "Zed License", - url: "https://fedoraproject.org/wiki/Licensing/Zed", - osiApproved: false, - }, - "Sun-PPP-2000": { - name: "Sun PPP License (2000)", - url: "https://github.com/ppp-project/ppp/blob/master/modules/ppp_ahdlc.c#L7-L19", - osiApproved: false, - }, - "SGI-B-1.0": { - name: "SGI Free Software License B v1.0", - url: "http://oss.sgi.com/projects/FreeB/SGIFreeSWLicB.1.0.html", - osiApproved: false, - }, - xlock: { - name: "xlock License", - url: "https://fossies.org/linux/tiff/contrib/ras/ras2tif.c", - osiApproved: false, - }, - "AGPL-3.0": { - name: "GNU Affero General Public License v3.0", - url: "https://www.gnu.org/licenses/agpl.txt", - osiApproved: true, - }, - SCEA: { - name: "SCEA Shared Source License", - url: "http://research.scea.com/scea_shared_source_license.html", - osiApproved: false, - }, - "Artistic-2.0": { - name: "Artistic License 2.0", - url: "http://www.perlfoundation.org/artistic_license_2_0", - osiApproved: true, - }, - ICU: { - name: "ICU License", - url: "http://source.icu-project.org/repos/icu/icu/trunk/license.html", - osiApproved: true, - }, - "CC-BY-2.5": { - name: "Creative Commons Attribution 2.5 Generic", - url: "https://creativecommons.org/licenses/by/2.5/legalcode", - osiApproved: false, - }, - "SHL-0.51": { - name: "Solderpad Hardware License, Version 0.51", - url: "https://solderpad.org/licenses/SHL-0.51/", - osiApproved: false, - }, - "LPPL-1.3a": { - name: "LaTeX Project Public License v1.3a", - url: "http://www.latex-project.org/lppl/lppl-1-3a.txt", - osiApproved: false, - }, - "CDLA-Permissive-1.0": { - name: "Community Data License Agreement Permissive 1.0", - url: "https://cdla.io/permissive-1-0", - osiApproved: false, - }, - "EFL-2.0": { - name: "Eiffel Forum License v2.0", - url: "http://www.eiffel-nice.org/license/eiffel-forum-license-2.html", - osiApproved: true, - }, - "URT-RLE": { - name: "Utah Raster Toolkit Run Length Encoded License", - url: "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/converter/other/pnmtorle.c", - osiApproved: false, - }, - "HPND-sell-regexpr": { - name: "Historical Permission Notice and Disclaimer - sell regexpr variant", - url: "https://gitlab.com/bacula-org/bacula/-/blob/Branch-11.0/bacula/LICENSE-FOSS?ref_type=heads#L245", - osiApproved: false, - }, - "GFDL-1.3-no-invariants-or-later": { - name: "GNU Free Documentation License v1.3 or later - no invariants", - url: "https://www.gnu.org/licenses/fdl-1.3.txt", - osiApproved: false, - }, - AMDPLPA: { - name: "AMD's plpa_map.c License", - url: "https://fedoraproject.org/wiki/Licensing/AMD_plpa_map_License", - osiApproved: false, - }, - "Bitstream-Charter": { - name: "Bitstream Charter Font License", - url: "https://fedoraproject.org/wiki/Licensing/Charter#License_Text", - osiApproved: false, - }, - "python-ldap": { - name: "Python ldap License", - url: "https://github.com/python-ldap/python-ldap/blob/main/LICENCE", - osiApproved: false, - }, - "CC-BY-SA-3.0-AT": { - name: "Creative Commons Attribution Share Alike 3.0 Austria", - url: "https://creativecommons.org/licenses/by-sa/3.0/at/legalcode", - osiApproved: false, - }, - "OGC-1.0": { - name: "OGC Software License, Version 1.0", - url: "https://www.ogc.org/ogc/software/1.0", - osiApproved: false, - }, - "CC-BY-SA-2.0": { - name: "Creative Commons Attribution Share Alike 2.0 Generic", - url: "https://creativecommons.org/licenses/by-sa/2.0/legalcode", - osiApproved: false, - }, - PADL: { - name: "PADL License", - url: "https://git.openldap.org/openldap/openldap/-/blob/master/libraries/libldap/os-local.c?ref_type=heads#L19-23", - osiApproved: false, - }, - "NICTA-1.0": { - name: "NICTA Public Software License, Version 1.0", - url: "https://opensource.apple.com/source/mDNSResponder/mDNSResponder-320.10/mDNSPosix/nss_ReadMe.txt", - osiApproved: false, - }, - "LPL-1.0": { - name: "Lucent Public License Version 1.0", - url: "https://opensource.org/licenses/LPL-1.0", - osiApproved: true, - }, - "LPPL-1.1": { - name: "LaTeX Project Public License v1.1", - url: "http://www.latex-project.org/lppl/lppl-1-1.txt", - osiApproved: false, - }, - "CDL-1.0": { - name: "Common Documentation License 1.0", - url: "http://www.opensource.apple.com/cdl/", - osiApproved: false, - }, - "Boehm-GC": { - name: "Boehm-Demers-Weiser GC License", - url: "https://fedoraproject.org/wiki/Licensing:MIT#Another_Minimal_variant_(found_in_libatomic_ops)", - osiApproved: false, - }, - "Sun-PPP": { - name: "Sun PPP License", - url: "https://github.com/ppp-project/ppp/blob/master/pppd/eap.c#L7-L16", - osiApproved: false, - }, - "OLDAP-2.2.1": { - name: "Open LDAP Public License v2.2.1", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=4bc786f34b50aa301be6f5600f58a980070f481e", - osiApproved: false, - }, - "AGPL-3.0-or-later": { - name: "GNU Affero General Public License v3.0 or later", - url: "https://www.gnu.org/licenses/agpl.txt", - osiApproved: true, - }, - "OLDAP-2.6": { - name: "Open LDAP Public License v2.6", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=1cae062821881f41b73012ba816434897abf4205", - osiApproved: false, - }, - "BSD-3-Clause-No-Nuclear-License": { - name: "BSD 3-Clause No Nuclear License", - url: "http://download.oracle.com/otn-pub/java/licenses/bsd.txt", - osiApproved: false, - }, - "BSD-Protection": { - name: "BSD Protection License", - url: "https://fedoraproject.org/wiki/Licensing/BSD_Protection_License", - osiApproved: false, - }, - "OCCT-PL": { - name: "Open CASCADE Technology Public License", - url: "http://www.opencascade.com/content/occt-public-license", - osiApproved: false, - }, - "GPL-2.0-with-font-exception": { - name: "GNU General Public License v2.0 w/Font exception", - url: "https://www.gnu.org/licenses/gpl-faq.html#FontException", - osiApproved: false, - }, - "YPL-1.0": { - name: "Yahoo! Public License v1.0", - url: "http://www.zimbra.com/license/yahoo_public_license_1.0.html", - osiApproved: false, - }, - MIPS: { - name: "MIPS License", - url: "https://sourceware.org/cgit/binutils-gdb/tree/include/coff/sym.h#n11", - osiApproved: false, - }, - "SGI-B-2.0": { - name: "SGI Free Software License B v2.0", - url: "http://oss.sgi.com/projects/FreeB/SGIFreeSWLicB.2.0.pdf", - osiApproved: false, - }, - "MIT-open-group": { - name: "MIT Open Group variant", - url: "https://gitlab.freedesktop.org/xorg/app/iceauth/-/blob/master/COPYING", - osiApproved: false, - }, - AML: { - name: "Apple MIT License", - url: "https://fedoraproject.org/wiki/Licensing/Apple_MIT_License", - osiApproved: false, - }, - "OSL-1.0": { - name: "Open Software License 1.0", - url: "https://opensource.org/licenses/OSL-1.0", - osiApproved: true, - }, - "GFDL-1.3-invariants-only": { - name: "GNU Free Documentation License v1.3 only - invariants", - url: "https://www.gnu.org/licenses/fdl-1.3.txt", - osiApproved: false, - }, - "bzip2-1.0.5": { - name: "bzip2 and libbzip2 License v1.0.5", - url: "https://sourceware.org/bzip2/1.0.5/bzip2-manual-1.0.5.html", - osiApproved: false, - }, - Symlinks: { - name: "Symlinks License", - url: "https://www.mail-archive.com/debian-bugs-rc@lists.debian.org/msg11494.html", - osiApproved: false, - }, - "Ruby-pty": { - name: "Ruby pty extension license", - url: "https://github.com/ruby/ruby/blob/9f6deaa6888a423720b4b127b5314f0ad26cc2e6/ext/pty/pty.c#L775-L786", - osiApproved: false, - }, - UCAR: { - name: "UCAR License", - url: "https://github.com/Unidata/UDUNITS-2/blob/master/COPYRIGHT", - osiApproved: false, - }, - "SimPL-2.0": { - name: "Simple Public License 2.0", - url: "https://opensource.org/licenses/SimPL-2.0", - osiApproved: true, - }, - "PolyForm-Noncommercial-1.0.0": { - name: "PolyForm Noncommercial License 1.0.0", - url: "https://polyformproject.org/licenses/noncommercial/1.0.0", - osiApproved: false, - }, - "OFL-1.1-no-RFN": { - name: "SIL Open Font License 1.1 with no Reserved Font Name", - url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web", - osiApproved: true, - }, - Furuseth: { - name: "Furuseth License", - url: "https://git.openldap.org/openldap/openldap/-/blob/master/COPYRIGHT?ref_type=heads#L39-51", - osiApproved: false, - }, - "Mackerras-3-Clause-acknowledgment": { - name: "Mackerras 3-Clause - acknowledgment variant", - url: "https://github.com/ppp-project/ppp/blob/master/pppd/auth.c#L6-L28", - osiApproved: false, - }, - "CC-PDM-1.0": { - name: "Creative Commons Public Domain Mark 1.0 Universal", - url: "https://creativecommons.org/publicdomain/mark/1.0/", - osiApproved: false, - }, - "LGPL-2.1+": { - name: "GNU Lesser General Public License v2.1 or later", - url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", - osiApproved: true, - }, - Zlib: { - name: "zlib License", - url: "http://www.zlib.net/zlib_license.html", - osiApproved: true, - }, - "BSD-2-Clause-Views": { - name: "BSD 2-Clause with views sentence", - url: "http://www.freebsd.org/copyright/freebsd-license.html", - osiApproved: false, - }, - "Interbase-1.0": { - name: "Interbase Public License v1.0", - url: "https://web.archive.org/web/20060319014854/http://info.borland.com/devsupport/interbase/opensource/IPL.html", - osiApproved: false, - }, - "LGPL-2.0": { - name: "GNU Library General Public License v2 only", - url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", - osiApproved: true, - }, - "LGPL-3.0-only": { - name: "GNU Lesser General Public License v3.0 only", - url: "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", - osiApproved: true, - }, - "CC-BY-NC-SA-3.0": { - name: "Creative Commons Attribution Non Commercial Share Alike 3.0 Unported", - url: "https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode", - osiApproved: false, - }, - "MIT-Modern-Variant": { - name: "MIT License Modern Variant", - url: "https://fedoraproject.org/wiki/Licensing:MIT#Modern_Variants", - osiApproved: true, - }, - "Unicode-TOU": { - name: "Unicode Terms of Use", - url: "http://web.archive.org/web/20140704074106/http://www.unicode.org/copyright.html", - osiApproved: false, - }, - APAFML: { - name: "Adobe Postscript AFM License", - url: "https://fedoraproject.org/wiki/Licensing/AdobePostscriptAFM", - osiApproved: false, - }, - TCL: { - name: "TCL/TK License", - url: "http://www.tcl.tk/software/tcltk/license.html", - osiApproved: false, - }, - Xerox: { - name: "Xerox License", - url: "https://fedoraproject.org/wiki/Licensing/Xerox", - osiApproved: false, - }, - FSFUL: { - name: "FSF Unlimited License", - url: "https://fedoraproject.org/wiki/Licensing/FSF_Unlimited_License", - osiApproved: false, - }, - "FSFAP-no-warranty-disclaimer": { - name: "FSF All Permissive License (without Warranty)", - url: "https://git.savannah.gnu.org/cgit/wget.git/tree/util/trunc.c?h=v1.21.3&id=40747a11e44ced5a8ac628a41f879ced3e2ebce9#n6", - osiApproved: false, - }, - "Artistic-1.0": { - name: "Artistic License 1.0", - url: "https://opensource.org/licenses/Artistic-1.0", - osiApproved: true, - }, - ImageMagick: { - name: "ImageMagick License", - url: "http://www.imagemagick.org/script/license.php", - osiApproved: false, - }, - "Brian-Gladman-2-Clause": { - name: "Brian Gladman 2-Clause License", - url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L140-L156", - osiApproved: false, - }, - "BitTorrent-1.1": { - name: "BitTorrent Open Source License v1.1", - url: "http://directory.fsf.org/wiki/License:BitTorrentOSL1.1", - osiApproved: false, - }, - "GPL-3.0-only": { - name: "GNU General Public License v3.0 only", - url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html", - osiApproved: true, - }, - "Linux-man-pages-copyleft": { - name: "Linux man-pages Copyleft", - url: "https://www.kernel.org/doc/man-pages/licenses.html", - osiApproved: false, - }, - "NTP-0": { - name: "NTP No Attribution", - url: "https://github.com/tytso/e2fsprogs/blob/master/lib/et/et_name.c", - osiApproved: false, - }, - curl: { - name: "curl License", - url: "https://github.com/bagder/curl/blob/master/COPYING", - osiApproved: false, - }, - MITNFA: { - name: "MIT +no-false-attribs license", - url: "https://fedoraproject.org/wiki/Licensing/MITNFA", - osiApproved: false, - }, - libtiff: { - name: "libtiff License", - url: "https://fedoraproject.org/wiki/Licensing/libtiff", - osiApproved: false, - }, - "ErlPL-1.1": { - name: "Erlang Public License v1.1", - url: "http://www.erlang.org/EPLICENSE", - osiApproved: false, - }, - "Adobe-Utopia": { - name: "Adobe Utopia Font License", - url: "https://gitlab.freedesktop.org/xorg/font/adobe-utopia-100dpi/-/blob/master/COPYING?ref_type=heads", - osiApproved: false, - }, - HaskellReport: { - name: "Haskell Language Report License", - url: "https://fedoraproject.org/wiki/Licensing/Haskell_Language_Report_License", - osiApproved: false, - }, - ISC: { - name: "ISC License", - url: "https://www.isc.org/licenses/", - osiApproved: true, - }, - Naumen: { - name: "Naumen Public License", - url: "https://opensource.org/licenses/Naumen", - osiApproved: true, - }, - "CC-BY-SA-1.0": { - name: "Creative Commons Attribution Share Alike 1.0 Generic", - url: "https://creativecommons.org/licenses/by-sa/1.0/legalcode", - osiApproved: false, - }, - "etalab-2.0": { - name: "Etalab Open License 2.0", - url: "https://github.com/DISIC/politique-de-contribution-open-source/blob/master/LICENSE.pdf", - osiApproved: false, - }, - "MPEG-SSG": { - name: "MPEG Software Simulation", - url: "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/converter/ppm/ppmtompeg/jrevdct.c#l1189", - osiApproved: false, - }, - CFITSIO: { - name: "CFITSIO License", - url: "https://heasarc.gsfc.nasa.gov/docs/software/fitsio/c/f_user/node9.html", - osiApproved: false, - }, - "MulanPSL-1.0": { - name: "Mulan Permissive Software License, Version 1", - url: "https://license.coscl.org.cn/MulanPSL/", - osiApproved: false, - }, - "GPL-2.0+": { - name: "GNU General Public License v2.0 or later", - url: "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", - osiApproved: true, - }, - "BSD-2-Clause-Patent": { - name: "BSD-2-Clause Plus Patent License", - url: "https://opensource.org/licenses/BSDplusPatent", - osiApproved: true, - }, - "CC-PDDC": { - name: "Creative Commons Public Domain Dedication and Certification", - url: "https://creativecommons.org/licenses/publicdomain/", - osiApproved: false, - }, - "TGPPL-1.0": { - name: "Transitive Grace Period Public Licence 1.0", - url: "https://fedoraproject.org/wiki/Licensing/TGPPL", - osiApproved: false, - }, - snprintf: { - name: "snprintf License", - url: "https://github.com/openssh/openssh-portable/blob/master/openbsd-compat/bsd-snprintf.c#L2", - osiApproved: false, - }, - Nunit: { - name: "Nunit License", - url: "https://fedoraproject.org/wiki/Licensing/Nunit", - osiApproved: false, - }, - "Boehm-GC-without-fee": { - name: "Boehm-Demers-Weiser GC License (without fee)", - url: "https://github.com/MariaDB/server/blob/11.6/libmysqld/lib_sql.cc", - osiApproved: false, - }, - Pixar: { - name: "Pixar License", - url: "https://github.com/PixarAnimationStudios/OpenSubdiv/raw/v3_5_0/LICENSE.txt", - osiApproved: false, - }, - "HPND-Netrek": { - name: "Historical Permission Notice and Disclaimer - Netrek variant", - osiApproved: false, - }, - Minpack: { - name: "Minpack License", - url: "http://www.netlib.org/minpack/disclaimer", - osiApproved: false, - }, - "GFDL-1.1-only": { - name: "GNU Free Documentation License v1.1 only", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", - osiApproved: false, - }, - "HPND-INRIA-IMAG": { - name: "Historical Permission Notice and Disclaimer - INRIA-IMAG variant", - url: "https://github.com/ppp-project/ppp/blob/master/pppd/ipv6cp.c#L75-L83", - osiApproved: false, - }, - "App-s2p": { - name: "App::s2p License", - url: "https://fedoraproject.org/wiki/Licensing/App-s2p", - osiApproved: false, - }, - "BSD-3-Clause-acpica": { - name: "BSD 3-Clause acpica variant", - url: "https://github.com/acpica/acpica/blob/master/source/common/acfileio.c#L119", - osiApproved: false, - }, - OGTSL: { - name: "Open Group Test Suite License", - url: "http://www.opengroup.org/testing/downloads/The_Open_Group_TSL.txt", - osiApproved: true, - }, - "ODbL-1.0": { - name: "Open Data Commons Open Database License v1.0", - url: "http://www.opendatacommons.org/licenses/odbl/1.0/", - osiApproved: false, - }, - "CC-BY-ND-3.0": { - name: "Creative Commons Attribution No Derivatives 3.0 Unported", - url: "https://creativecommons.org/licenses/by-nd/3.0/legalcode", - osiApproved: false, - }, - "CC-BY-SA-2.5": { - name: "Creative Commons Attribution Share Alike 2.5 Generic", - url: "https://creativecommons.org/licenses/by-sa/2.5/legalcode", - osiApproved: false, - }, - "OLDAP-2.7": { - name: "Open LDAP Public License v2.7", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=47c2415c1df81556eeb39be6cad458ef87c534a2", - osiApproved: false, - }, - "UCL-1.0": { - name: "Upstream Compatibility License v1.0", - url: "https://opensource.org/licenses/UCL-1.0", - osiApproved: true, - }, - MTLL: { - name: "Matrix Template Library License", - url: "https://fedoraproject.org/wiki/Licensing/Matrix_Template_Library_License", - osiApproved: false, - }, - "HPND-export2-US": { - name: "HPND with US Government export control and 2 disclaimers", - url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L111-L133", - osiApproved: false, - }, - "OFL-1.0-RFN": { - name: "SIL Open Font License 1.0 with Reserved Font Name", - url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL10_web", - osiApproved: false, - }, - "ZPL-2.0": { - name: "Zope Public License 2.0", - url: "http://old.zope.org/Resources/License/ZPL-2.0", - osiApproved: true, - }, - "bcrypt-Solar-Designer": { - name: "bcrypt Solar Designer License", - url: "https://github.com/bcrypt-ruby/bcrypt-ruby/blob/master/ext/mri/crypt_blowfish.c", - osiApproved: false, - }, - "CC-BY-NC-SA-3.0-DE": { - name: "Creative Commons Attribution Non Commercial Share Alike 3.0 Germany", - url: "https://creativecommons.org/licenses/by-nc-sa/3.0/de/legalcode", - osiApproved: false, - }, - "GFDL-1.1-no-invariants-or-later": { - name: "GNU Free Documentation License v1.1 or later - no invariants", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", - osiApproved: false, - }, - "CC-BY-SA-3.0-IGO": { - name: "Creative Commons Attribution-ShareAlike 3.0 IGO", - url: "https://creativecommons.org/licenses/by-sa/3.0/igo/legalcode", - osiApproved: false, - }, - "Apache-1.1": { - name: "Apache License 1.1", - url: "http://apache.org/licenses/LICENSE-1.1", - osiApproved: true, - }, - "GPL-2.0-with-autoconf-exception": { - name: "GNU General Public License v2.0 w/Autoconf exception", - url: "http://ac-archive.sourceforge.net/doc/copyright.html", - osiApproved: false, - }, - "Caldera-no-preamble": { - name: "Caldera License (without preamble)", - url: "https://github.com/apache/apr/blob/trunk/LICENSE#L298C6-L298C29", - osiApproved: false, - }, - "SSPL-1.0": { - name: "Server Side Public License, v 1", - url: "https://www.mongodb.com/licensing/server-side-public-license", - osiApproved: false, - }, - "DRL-1.1": { - name: "Detection Rule License 1.1", - url: "https://github.com/SigmaHQ/Detection-Rule-License/blob/6ec7fbde6101d101b5b5d1fcb8f9b69fbc76c04a/LICENSE.Detection.Rules.md", - osiApproved: false, - }, - "Linux-man-pages-copyleft-2-para": { - name: "Linux man-pages Copyleft - 2 paragraphs", - url: "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/move_pages.2#n5", - osiApproved: false, - }, - "OLDAP-2.0.1": { - name: "Open LDAP Public License v2.0.1", - url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=b6d68acd14e51ca3aab4428bf26522aa74873f0e", - osiApproved: false, - }, - "ANTLR-PD-fallback": { - name: "ANTLR Software Rights Notice with license fallback", - url: "http://www.antlr2.org/license.html", - osiApproved: false, - }, - "CDLA-Permissive-2.0": { - name: "Community Data License Agreement Permissive 2.0", - url: "https://cdla.dev/permissive-2-0", - osiApproved: false, - }, - HIDAPI: { - name: "HIDAPI License", - url: "https://github.com/signal11/hidapi/blob/master/LICENSE-orig.txt", - osiApproved: false, - }, - "bzip2-1.0.6": { - name: "bzip2 and libbzip2 License v1.0.6", - url: "https://sourceware.org/git/?p=bzip2.git;a=blob;f=LICENSE;hb=bzip2-1.0.6", - osiApproved: false, - }, - GL2PS: { - name: "GL2PS License", - url: "http://www.geuz.org/gl2ps/COPYING.GL2PS", - osiApproved: false, - }, - TOSL: { - name: "Trusster Open Source License", - url: "https://fedoraproject.org/wiki/Licensing/TOSL", - osiApproved: false, - }, - Abstyles: { - name: "Abstyles License", - url: "https://fedoraproject.org/wiki/Licensing/Abstyles", - osiApproved: false, - }, - TermReadKey: { - name: "TermReadKey License", - url: "https://github.com/jonathanstowe/TermReadKey/blob/master/README#L9-L10", - osiApproved: false, - }, - "GFDL-1.2": { - name: "GNU Free Documentation License v1.2", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", - osiApproved: false, - }, - xzoom: { - name: "xzoom License", - url: "https://metadata.ftp-master.debian.org/changelogs//main/x/xzoom/xzoom_0.3-27_copyright", - osiApproved: false, - }, - PostgreSQL: { - name: "PostgreSQL License", - url: "http://www.postgresql.org/about/licence", - osiApproved: true, - }, - "CNRI-Python-GPL-Compatible": { - name: "CNRI Python Open Source GPL Compatible License Agreement", - url: "http://www.python.org/download/releases/1.6.1/download_win/", - osiApproved: false, - }, - "Widget-Workshop": { - name: "Widget Workshop License", - url: "https://github.com/novnc/noVNC/blob/master/core/crypto/des.js#L24", - osiApproved: false, - }, - Libpng: { - name: "libpng License", - url: "http://www.libpng.org/pub/png/src/libpng-LICENSE.txt", - osiApproved: false, - }, - "HPND-sell-MIT-disclaimer-xserver": { - name: "Historical Permission Notice and Disclaimer - sell xserver variant with MIT disclaimer", - url: "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L1781", - osiApproved: false, - }, - "CC-BY-NC-SA-1.0": { - name: "Creative Commons Attribution Non Commercial Share Alike 1.0 Generic", - url: "https://creativecommons.org/licenses/by-nc-sa/1.0/legalcode", - osiApproved: false, - }, - "Python-2.0": { - name: "Python License 2.0", - url: "https://opensource.org/licenses/Python-2.0", - osiApproved: true, - }, - "BSD-Systemics-W3Works": { - name: "Systemics W3Works BSD variant license", - url: "https://metacpan.org/release/DPARIS/Crypt-Blowfish-2.14/source/COPYRIGHT#L7", - osiApproved: false, - }, - "LPPL-1.0": { - name: "LaTeX Project Public License v1.0", - url: "http://www.latex-project.org/lppl/lppl-1-0.txt", - osiApproved: false, - }, - "YPL-1.1": { - name: "Yahoo! Public License v1.1", - url: "http://www.zimbra.com/license/yahoo_public_license_1.1.html", - osiApproved: false, - }, - SWL: { - name: "Scheme Widget Library (SWL) Software License Agreement", - url: "https://fedoraproject.org/wiki/Licensing/SWL", - osiApproved: false, - }, - Giftware: { - name: "Giftware License", - url: "http://liballeg.org/license.html#allegro-4-the-giftware-license", - osiApproved: false, - }, - "CECILL-B": { - name: "CeCILL-B Free Software License Agreement", - url: "http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html", - osiApproved: false, - }, - "OSET-PL-2.1": { - name: "OSET Public License version 2.1", - url: "http://www.osetfoundation.org/public-license", - osiApproved: true, - }, - "GPL-3.0-with-autoconf-exception": { - name: "GNU General Public License v3.0 w/Autoconf exception", - url: "https://www.gnu.org/licenses/autoconf-exception-3.0.html", - osiApproved: false, - }, - "CAL-1.0-Combined-Work-Exception": { - name: "Cryptographic Autonomy License 1.0 (Combined Work Exception)", - url: "http://cryptographicautonomylicense.com/license-text.html", - osiApproved: true, - }, - "HPND-sell-variant-MIT-disclaimer-rev": { - name: "HPND sell variant with MIT disclaimer - reverse", - url: "https://github.com/sigmavirus24/x11-ssh-askpass/blob/master/dynlist.c", - osiApproved: false, - }, - JSON: { - name: "JSON License", - url: "http://www.json.org/license.html", - osiApproved: false, - }, - "GFDL-1.2-only": { - name: "GNU Free Documentation License v1.2 only", - url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", - osiApproved: false, - }, - pkgconf: { - name: "pkgconf License", - url: "https://github.com/pkgconf/pkgconf/blob/master/cli/main.c#L8", - osiApproved: false, - }, - "Unicode-DFS-2016": { - name: "Unicode License Agreement - Data Files and Software (2016)", - url: "https://www.unicode.org/license.txt", - osiApproved: true, - }, - "PHP-3.01": { - name: "PHP License v3.01", - url: "http://www.php.net/license/3_01.txt", - osiApproved: true, - }, - blessing: { - name: "SQLite Blessing", - url: "https://www.sqlite.org/src/artifact/e33a4df7e32d742a?ln=4-9", - osiApproved: false, - }, - "RPSL-1.0": { - name: "RealNetworks Public Source License v1.0", - url: "https://helixcommunity.org/content/rpsl", - osiApproved: true, - }, - "BitTorrent-1.0": { - name: "BitTorrent Open Source License v1.0", - url: "http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/licenses/BitTorrent?r1=1.1&r2=1.1.1.1&diff_format=s", - osiApproved: false, - }, - "SISSL-1.2": { - name: "Sun Industry Standards Source License v1.2", - url: "http://gridscheduler.sourceforge.net/Gridengine_SISSL_license.html", - osiApproved: false, - }, - "GPL-3.0": { - name: "GNU General Public License v3.0 only", - url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html", - osiApproved: true, - }, - IJG: { - name: "Independent JPEG Group License", - url: "http://dev.w3.org/cvsweb/Amaya/libjpeg/Attic/README?rev=1.2", - osiApproved: false, - }, - "OGL-Canada-2.0": { - name: "Open Government Licence - Canada", - url: "https://open.canada.ca/en/open-government-licence-canada", - osiApproved: false, - }, - "CC-BY-ND-2.5": { - name: "Creative Commons Attribution No Derivatives 2.5 Generic", - url: "https://creativecommons.org/licenses/by-nd/2.5/legalcode", - osiApproved: false, - }, - "HPND-Pbmplus": { - name: "Historical Permission Notice and Disclaimer - Pbmplus variant", - url: "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/netpbm.c#l8", - osiApproved: false, - }, - "CC-BY-NC-ND-3.0-DE": { - name: "Creative Commons Attribution Non Commercial No Derivatives 3.0 Germany", - url: "https://creativecommons.org/licenses/by-nc-nd/3.0/de/legalcode", - osiApproved: false, - }, - "RPL-1.5": { - name: "Reciprocal Public License 1.5", - url: "https://opensource.org/licenses/RPL-1.5", - osiApproved: true, - }, - Nokia: { - name: "Nokia Open Source License", - url: "https://opensource.org/licenses/nokia", - osiApproved: true, - }, - "HPND-doc-sell": { - name: "Historical Permission Notice and Disclaimer - documentation sell variant", - url: "https://gitlab.freedesktop.org/xorg/lib/libxtst/-/blob/master/COPYING?ref_type=heads#L108-117", - osiApproved: false, - }, + DSDP: { + name: "DSDP License", + url: "https://fedoraproject.org/wiki/Licensing/DSDP", + osiApproved: false, + }, + "NIST-PD": { + name: "NIST Public Domain Notice", + url: "https://github.com/tcheneau/simpleRPL/blob/e645e69e38dd4e3ccfeceb2db8cba05b7c2e0cd3/LICENSE.txt", + osiApproved: false, + }, + "CC-BY-NC-SA-2.0": { + name: "Creative Commons Attribution Non Commercial Share Alike 2.0 Generic", + url: "https://creativecommons.org/licenses/by-nc-sa/2.0/legalcode", + osiApproved: false, + }, + "NLOD-1.0": { + name: "Norwegian Licence for Open Government Data (NLOD) 1.0", + url: "http://data.norge.no/nlod/en/1.0", + osiApproved: false, + }, + "RHeCos-1.1": { + name: "Red Hat eCos Public License v1.1", + url: "http://ecos.sourceware.org/old-license.html", + osiApproved: false, + }, + "GFDL-1.3-no-invariants-only": { + name: "GNU Free Documentation License v1.3 only - no invariants", + url: "https://www.gnu.org/licenses/fdl-1.3.txt", + osiApproved: false, + }, + RSCPL: { + name: "Ricoh Source Code Public License", + url: "http://wayback.archive.org/web/20060715140826/http://www.risource.org/RPL/RPL-1.0A.shtml", + osiApproved: true, + }, + "ASWF-Digital-Assets-1.1": { + name: "ASWF Digital Assets License 1.1", + url: "https://github.com/AcademySoftwareFoundation/foundation/blob/main/digital_assets/aswf_digital_assets_license_v1.1.txt", + osiApproved: false, + }, + "eCos-2.0": { + name: "eCos license version 2.0", + url: "https://www.gnu.org/licenses/ecos-license.html", + osiApproved: false, + }, + GLWTPL: { + name: "Good Luck With That Public License", + url: "https://github.com/me-shaon/GLWTPL/commit/da5f6bc734095efbacb442c0b31e33a65b9d6e85", + osiApproved: false, + }, + "Info-ZIP": { + name: "Info-ZIP License", + url: "http://www.info-zip.org/license.html", + osiApproved: false, + }, + "LPPL-1.3c": { + name: "LaTeX Project Public License v1.3c", + url: "http://www.latex-project.org/lppl/lppl-1-3c.txt", + osiApproved: true, + }, + "zlib-acknowledgement": { + name: "zlib/libpng License with Acknowledgement", + url: "https://fedoraproject.org/wiki/Licensing/ZlibWithAcknowledgement", + osiApproved: false, + }, + checkmk: { + name: "Checkmk License", + url: "https://github.com/libcheck/check/blob/master/checkmk/checkmk.in", + osiApproved: false, + }, + "OLDAP-2.8": { + name: "Open LDAP Public License v2.8", + url: "http://www.openldap.org/software/release/license.html", + osiApproved: true, + }, + "cve-tou": { + name: "Common Vulnerability Enumeration ToU License", + url: "https://www.cve.org/Legal/TermsOfUse", + osiApproved: false, + }, + MirOS: { + name: "The MirOS Licence", + url: "https://opensource.org/licenses/MirOS", + osiApproved: true, + }, + "Parity-6.0.0": { + name: "The Parity Public License 6.0.0", + url: "https://paritylicense.com/versions/6.0.0.html", + osiApproved: false, + }, + "CC-BY-SA-2.1-JP": { + name: "Creative Commons Attribution Share Alike 2.1 Japan", + url: "https://creativecommons.org/licenses/by-sa/2.1/jp/legalcode", + osiApproved: false, + }, + InnoSetup: { + name: "Inno Setup License", + url: "https://github.com/jrsoftware/issrc/blob/HEAD/license.txt", + osiApproved: false, + }, + "IPL-1.0": { + name: "IBM Public License v1.0", + url: "https://opensource.org/licenses/IPL-1.0", + osiApproved: true, + }, + "Spencer-86": { + name: "Spencer License 86", + url: "https://fedoraproject.org/wiki/Licensing/Henry_Spencer_Reg-Ex_Library_License", + osiApproved: false, + }, + JPNIC: { + name: "Japan Network Information Center License", + url: "https://gitlab.isc.org/isc-projects/bind9/blob/master/COPYRIGHT#L366", + osiApproved: false, + }, + OpenVision: { + name: "OpenVision License", + url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L66-L98", + osiApproved: false, + }, + SGP4: { + name: "SGP4 Permission Notice", + url: "https://celestrak.org/publications/AIAA/2006-6753/faq.php", + osiApproved: false, + }, + "MPL-1.1": { + name: "Mozilla Public License 1.1", + url: "http://www.mozilla.org/MPL/MPL-1.1.html", + osiApproved: true, + }, + "BSD-3-Clause-Clear": { + name: "BSD 3-Clause Clear License", + url: "http://labs.metacarta.com/license-explanation.html#license", + osiApproved: false, + }, + "AML-glslang": { + name: "AML glslang variant License", + url: "https://github.com/KhronosGroup/glslang/blob/main/LICENSE.txt#L949", + osiApproved: false, + }, + Vim: { + name: "Vim License", + url: "http://vimdoc.sourceforge.net/htmldoc/uganda.html", + osiApproved: false, + }, + "Community-Spec-1.0": { + name: "Community Specification License 1.0", + url: "https://github.com/CommunitySpecification/1.0/blob/master/1._Community_Specification_License-v1.md", + osiApproved: false, + }, + "OSL-3.0": { + name: "Open Software License 3.0", + url: "https://web.archive.org/web/20120101081418/http://rosenlaw.com:80/OSL3.0.htm", + osiApproved: true, + }, + CrystalStacker: { + name: "CrystalStacker License", + url: "https://fedoraproject.org/wiki/Licensing:CrystalStacker?rd=Licensing/CrystalStacker", + osiApproved: false, + }, + "MPL-1.0": { + name: "Mozilla Public License 1.0", + url: "http://www.mozilla.org/MPL/MPL-1.0.html", + osiApproved: true, + }, + "OLDAP-1.2": { + name: "Open LDAP Public License v1.2", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=42b0383c50c299977b5893ee695cf4e486fb0dc7", + osiApproved: false, + }, + "Sendmail-8.23": { + name: "Sendmail License 8.23", + url: "https://www.proofpoint.com/sites/default/files/sendmail-license.pdf", + osiApproved: false, + }, + "CMU-Mach": { + name: "CMU Mach License", + url: "https://www.cs.cmu.edu/~410/licenses.html", + osiApproved: false, + }, + xpp: { + name: "XPP License", + url: "https://fedoraproject.org/wiki/Licensing/xpp", + osiApproved: false, + }, + "GPL-2.0-with-bison-exception": { + name: "GNU General Public License v2.0 w/Bison exception", + url: "http://git.savannah.gnu.org/cgit/bison.git/tree/data/yacc.c?id=193d7c7054ba7197b0789e14965b739162319b5e#n141", + osiApproved: false, + }, + "ECL-1.0": { + name: "Educational Community License v1.0", + url: "https://opensource.org/licenses/ECL-1.0", + osiApproved: true, + }, + Plexus: { + name: "Plexus Classworlds License", + url: "https://fedoraproject.org/wiki/Licensing/Plexus_Classworlds_License", + osiApproved: false, + }, + "Elastic-2.0": { + name: "Elastic License 2.0", + url: "https://www.elastic.co/licensing/elastic-license", + osiApproved: false, + }, + "CPL-1.0": { + name: "Common Public License 1.0", + url: "https://opensource.org/licenses/CPL-1.0", + osiApproved: true, + }, + "GFDL-1.2-no-invariants-only": { + name: "GNU Free Documentation License v1.2 only - no invariants", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", + osiApproved: false, + }, + "OPL-1.0": { + name: "Open Public License v1.0", + url: "http://old.koalateam.com/jackaroo/OPL_1_0.TXT", + osiApproved: false, + }, + "CC-BY-SA-4.0": { + name: "Creative Commons Attribution Share Alike 4.0 International", + url: "https://creativecommons.org/licenses/by-sa/4.0/legalcode", + osiApproved: false, + }, + ADSL: { + name: "Amazon Digital Services License", + url: "https://fedoraproject.org/wiki/Licensing/AmazonDigitalServicesLicense", + osiApproved: false, + }, + "SGI-B-1.1": { + name: "SGI Free Software License B v1.1", + url: "http://oss.sgi.com/projects/FreeB/", + osiApproved: false, + }, + "XFree86-1.1": { + name: "XFree86 License 1.1", + url: "http://www.xfree86.org/current/LICENSE4.html", + osiApproved: false, + }, + "Latex2e-translated-notice": { + name: "Latex2e with translated notice permission", + url: "https://git.savannah.gnu.org/cgit/indent.git/tree/doc/indent.texi?id=a74c6b4ee49397cf330b333da1042bffa60ed14f#n74", + osiApproved: false, + }, + IPA: { + name: "IPA Font License", + url: "https://opensource.org/licenses/IPA", + osiApproved: true, + }, + psutils: { + name: "psutils License", + url: "https://fedoraproject.org/wiki/Licensing/psutils", + osiApproved: false, + }, + "CC-BY-NC-ND-3.0": { + name: "Creative Commons Attribution Non Commercial No Derivatives 3.0 Unported", + url: "https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode", + osiApproved: false, + }, + FSFULLR: { + name: "FSF Unlimited License (with License Retention)", + url: "https://fedoraproject.org/wiki/Licensing/FSF_Unlimited_License#License_Retention_Variant", + osiApproved: false, + }, + "SSLeay-standalone": { + name: "SSLeay License - standalone", + url: "https://www.tq-group.com/filedownloads/files/software-license-conditions/OriginalSSLeay/OriginalSSLeay.pdf", + osiApproved: false, + }, + MMIXware: { + name: "MMIXware License", + url: "https://gitlab.lrz.de/mmix/mmixware/-/blob/master/boilerplate.w", + osiApproved: false, + }, + "Graphics-Gems": { + name: "Graphics Gems License", + url: "https://github.com/erich666/GraphicsGems/blob/master/LICENSE.md", + osiApproved: false, + }, + "HPND-export-US-acknowledgement": { + name: "HPND with US Government export control warning and acknowledgment", + url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L831-L852", + osiApproved: false, + }, + "CC-BY-NC-2.0": { + name: "Creative Commons Attribution Non Commercial 2.0 Generic", + url: "https://creativecommons.org/licenses/by-nc/2.0/legalcode", + osiApproved: false, + }, + "OLDAP-1.3": { + name: "Open LDAP Public License v1.3", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=e5f8117f0ce088d0bd7a8e18ddf37eaa40eb09b1", + osiApproved: false, + }, + "LGPL-2.1-only": { + name: "GNU Lesser General Public License v2.1 only", + url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", + osiApproved: true, + }, + "NLOD-2.0": { + name: "Norwegian Licence for Open Government Data (NLOD) 2.0", + url: "http://data.norge.no/nlod/en/2.0", + osiApproved: false, + }, + "BSD-2-Clause": { + name: 'BSD 2-Clause "Simplified" License', + url: "https://opensource.org/licenses/BSD-2-Clause", + osiApproved: true, + }, + mailprio: { + name: "mailprio License", + url: "https://fossies.org/linux/sendmail/contrib/mailprio", + osiApproved: false, + }, + "CC-BY-SA-3.0": { + name: "Creative Commons Attribution Share Alike 3.0 Unported", + url: "https://creativecommons.org/licenses/by-sa/3.0/legalcode", + osiApproved: false, + }, + Noweb: { + name: "Noweb License", + url: "https://fedoraproject.org/wiki/Licensing/Noweb", + osiApproved: false, + }, + Soundex: { + name: "Soundex License", + url: "https://metacpan.org/release/RJBS/Text-Soundex-3.05/source/Soundex.pm#L3-11", + osiApproved: false, + }, + "CECILL-1.0": { + name: "CeCILL Free Software License Agreement v1.0", + url: "http://www.cecill.info/licences/Licence_CeCILL_V1-fr.html", + osiApproved: false, + }, + Aladdin: { + name: "Aladdin Free Public License", + url: "http://pages.cs.wisc.edu/~ghost/doc/AFPL/6.01/Public.htm", + osiApproved: false, + }, + "SSH-OpenSSH": { + name: "SSH OpenSSH license", + url: "https://github.com/openssh/openssh-portable/blob/1b11ea7c58cd5c59838b5fa574cd456d6047b2d4/LICENCE#L10", + osiApproved: false, + }, + "BSD-Attribution-HPND-disclaimer": { + name: "BSD with Attribution and HPND disclaimer", + url: "https://github.com/cyrusimap/cyrus-sasl/blob/master/COPYING", + osiApproved: false, + }, + "CC-BY-NC-SA-2.0-UK": { + name: "Creative Commons Attribution Non Commercial Share Alike 2.0 England and Wales", + url: "https://creativecommons.org/licenses/by-nc-sa/2.0/uk/legalcode", + osiApproved: false, + }, + Kazlib: { + name: "Kazlib License", + url: "http://git.savannah.gnu.org/cgit/kazlib.git/tree/except.c?id=0062df360c2d17d57f6af19b0e444c51feb99036", + osiApproved: false, + }, + "Ubuntu-font-1.0": { + name: "Ubuntu Font Licence v1.0", + url: "https://ubuntu.com/legal/font-licence", + osiApproved: false, + }, + "SGI-OpenGL": { + name: "SGI OpenGL License", + url: "https://gitlab.freedesktop.org/mesa/glw/-/blob/master/README?ref_type=heads", + osiApproved: false, + }, + Rdisc: { + name: "Rdisc License", + url: "https://fedoraproject.org/wiki/Licensing/Rdisc_License", + osiApproved: false, + }, + "HPND-sell-variant-MIT-disclaimer": { + name: "HPND sell variant with MIT disclaimer", + url: "https://github.com/sigmavirus24/x11-ssh-askpass/blob/master/README", + osiApproved: false, + }, + LGPLLR: { + name: "Lesser General Public License For Linguistic Resources", + url: "http://www-igm.univ-mlv.fr/~unitex/lgpllr.html", + osiApproved: false, + }, + OAR: { + name: "OAR License", + url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/string/strsignal.c;hb=HEAD#l35", + osiApproved: false, + }, + HTMLTIDY: { + name: "HTML Tidy License", + url: "https://github.com/htacg/tidy-html5/blob/next/README/LICENSE.md", + osiApproved: false, + }, + AMPAS: { + name: "Academy of Motion Picture Arts and Sciences BSD", + url: "https://fedoraproject.org/wiki/Licensing/BSD#AMPASBSD", + osiApproved: false, + }, + NOSL: { + name: "Netizen Open Source License", + url: "http://bits.netizen.com.au/licenses/NOSL/nosl.txt", + osiApproved: false, + }, + fwlw: { + name: "fwlw License", + url: "https://mirrors.nic.cz/tex-archive/macros/latex/contrib/fwlw/README", + osiApproved: false, + }, + w3m: { + name: "w3m License", + url: "https://github.com/tats/w3m/blob/master/COPYING", + osiApproved: false, + }, + Latex2e: { + name: "Latex2e License", + url: "https://fedoraproject.org/wiki/Licensing/Latex2e", + osiApproved: false, + }, + "O-UDA-1.0": { + name: "Open Use of Data Agreement v1.0", + url: "https://github.com/microsoft/Open-Use-of-Data-Agreement/blob/v1.0/O-UDA-1.0.md", + osiApproved: false, + }, + mplus: { + name: "mplus Font License", + url: "https://fedoraproject.org/wiki/Licensing:Mplus?rd=Licensing/mplus", + osiApproved: false, + }, + "HPND-Intel": { + name: "Historical Permission Notice and Disclaimer - Intel variant", + url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/machine/i960/memcpy.S;hb=HEAD", + osiApproved: false, + }, + PPL: { + name: "Peer Production License", + url: "https://wiki.p2pfoundation.net/Peer_Production_License", + osiApproved: false, + }, + "OFL-1.1-RFN": { + name: "SIL Open Font License 1.1 with Reserved Font Name", + url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web", + osiApproved: true, + }, + "EPL-1.0": { + name: "Eclipse Public License 1.0", + url: "http://www.eclipse.org/legal/epl-v10.html", + osiApproved: true, + }, + "HPND-UC-export-US": { + name: "Historical Permission Notice and Disclaimer - University of California, US export warning", + url: "https://github.com/RTimothyEdwards/magic/blob/master/LICENSE", + osiApproved: false, + }, + "CC-BY-3.0-DE": { + name: "Creative Commons Attribution 3.0 Germany", + url: "https://creativecommons.org/licenses/by/3.0/de/legalcode", + osiApproved: false, + }, + SNIA: { + name: "SNIA Public License 1.1", + url: "https://fedoraproject.org/wiki/Licensing/SNIA_Public_License", + osiApproved: false, + }, + Barr: { + name: "Barr License", + url: "https://fedoraproject.org/wiki/Licensing/Barr", + osiApproved: false, + }, + "OLDAP-2.1": { + name: "Open LDAP Public License v2.1", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=b0d176738e96a0d3b9f85cb51e140a86f21be715", + osiApproved: false, + }, + "CC-BY-ND-4.0": { + name: "Creative Commons Attribution No Derivatives 4.0 International", + url: "https://creativecommons.org/licenses/by-nd/4.0/legalcode", + osiApproved: false, + }, + softSurfer: { + name: "softSurfer License", + url: "https://github.com/mm2/Little-CMS/blob/master/src/cmssm.c#L207", + osiApproved: false, + }, + "LGPL-2.1-or-later": { + name: "GNU Lesser General Public License v2.1 or later", + url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", + osiApproved: true, + }, + "OFL-1.0": { + name: "SIL Open Font License 1.0", + url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL10_web", + osiApproved: false, + }, + "BSD-3-Clause-flex": { + name: "BSD 3-Clause Flex variant", + url: "https://github.com/westes/flex/blob/master/COPYING", + osiApproved: false, + }, + psfrag: { + name: "psfrag License", + url: "https://fedoraproject.org/wiki/Licensing/psfrag", + osiApproved: false, + }, + "BSD-1-Clause": { + name: "BSD 1-Clause License", + url: "https://svnweb.freebsd.org/base/head/include/ifaddrs.h?revision=326823", + osiApproved: true, + }, + "BSD-3-Clause-No-Military-License": { + name: "BSD 3-Clause No Military License", + url: "https://gitlab.syncad.com/hive/dhive/-/blob/master/LICENSE", + osiApproved: false, + }, + Cube: { + name: "Cube License", + url: "https://fedoraproject.org/wiki/Licensing/Cube", + osiApproved: false, + }, + "LPPL-1.2": { + name: "LaTeX Project Public License v1.2", + url: "http://www.latex-project.org/lppl/lppl-1-2.txt", + osiApproved: false, + }, + "OLDAP-2.2.2": { + name: "Open LDAP Public License 2.2.2", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=df2cc1e21eb7c160695f5b7cffd6296c151ba188", + osiApproved: false, + }, + TTWL: { + name: "Text-Tabs+Wrap License", + url: "https://fedoraproject.org/wiki/Licensing/TTWL", + osiApproved: false, + }, + "CC-BY-3.0": { + name: "Creative Commons Attribution 3.0 Unported", + url: "https://creativecommons.org/licenses/by/3.0/legalcode", + osiApproved: false, + }, + "BSD-3-Clause-Open-MPI": { + name: "BSD 3-Clause Open MPI variant", + url: "https://www.open-mpi.org/community/license.php", + osiApproved: false, + }, + "CC-BY-NC-ND-3.0-IGO": { + name: "Creative Commons Attribution Non Commercial No Derivatives 3.0 IGO", + url: "https://creativecommons.org/licenses/by-nc-nd/3.0/igo/legalcode", + osiApproved: false, + }, + "ZPL-2.1": { + name: "Zope Public License 2.1", + url: "http://old.zope.org/Resources/ZPL/", + osiApproved: true, + }, + "CC0-1.0": { + name: "Creative Commons Zero v1.0 Universal", + url: "https://creativecommons.org/publicdomain/zero/1.0/legalcode", + osiApproved: false, + }, + "NPL-1.0": { + name: "Netscape Public License v1.0", + url: "http://www.mozilla.org/MPL/NPL/1.0/", + osiApproved: false, + }, + "CECILL-2.0": { + name: "CeCILL Free Software License Agreement v2.0", + url: "http://www.cecill.info/licences/Licence_CeCILL_V2-en.html", + osiApproved: false, + }, + wwl: { + name: "WWL License", + url: "http://www.db.net/downloads/wwl+db-1.3.tgz", + osiApproved: false, + }, + NGPL: { + name: "Nethack General Public License", + url: "https://opensource.org/licenses/NGPL", + osiApproved: true, + }, + FSFAP: { + name: "FSF All Permissive License", + url: "https://www.gnu.org/prep/maintain/html_node/License-Notices-for-Other-Files.html", + osiApproved: false, + }, + "any-OSI": { + name: "Any OSI License", + url: "https://metacpan.org/pod/Exporter::Tidy#LICENSE", + osiApproved: false, + }, + mpich2: { + name: "mpich2 License", + url: "https://fedoraproject.org/wiki/Licensing/MIT", + osiApproved: false, + }, + EUDatagrid: { + name: "EU DataGrid Software License", + url: "http://eu-datagrid.web.cern.ch/eu-datagrid/license.html", + osiApproved: true, + }, + Sleepycat: { + name: "Sleepycat License", + url: "https://opensource.org/licenses/Sleepycat", + osiApproved: true, + }, + "AFL-3.0": { + name: "Academic Free License v3.0", + url: "http://www.rosenlaw.com/AFL3.0.htm", + osiApproved: true, + }, + "Arphic-1999": { + name: "Arphic Public License", + url: "http://ftp.gnu.org/gnu/non-gnu/chinese-fonts-truetype/LICENSE", + osiApproved: false, + }, + "BSD-4-Clause-UC": { + name: "BSD-4-Clause (University of California-Specific)", + url: "http://www.freebsd.org/copyright/license.html", + osiApproved: false, + }, + dtoa: { + name: "David M. Gay dtoa License", + url: "https://github.com/SWI-Prolog/swipl-devel/blob/master/src/os/dtoa.c", + osiApproved: false, + }, + "Unicode-DFS-2015": { + name: "Unicode License Agreement - Data Files and Software (2015)", + url: "https://web.archive.org/web/20151224134844/http://unicode.org/copyright.html", + osiApproved: false, + }, + "TCP-wrappers": { + name: "TCP Wrappers License", + url: "http://rc.quest.com/topics/openssh/license.php#tcpwrappers", + osiApproved: false, + }, + "MIT-0": { + name: "MIT No Attribution", + url: "https://github.com/aws/mit-0", + osiApproved: true, + }, + "SugarCRM-1.1.3": { + name: "SugarCRM Public License v1.1.3", + url: "http://www.sugarcrm.com/crm/SPL", + osiApproved: false, + }, + iMatix: { + name: "iMatix Standard Function Library Agreement", + url: "http://legacy.imatix.com/html/sfl/sfl4.htm#license", + osiApproved: false, + }, + "CC-BY-3.0-AT": { + name: "Creative Commons Attribution 3.0 Austria", + url: "https://creativecommons.org/licenses/by/3.0/at/legalcode", + osiApproved: false, + }, + "Adobe-2006": { + name: "Adobe Systems Incorporated Source Code License Agreement", + url: "https://fedoraproject.org/wiki/Licensing/AdobeLicense", + osiApproved: false, + }, + LOOP: { + name: "Common Lisp LOOP License", + url: "https://gitlab.com/embeddable-common-lisp/ecl/-/blob/develop/src/lsp/loop.lsp", + osiApproved: false, + }, + "MIT-testregex": { + name: "MIT testregex Variant", + url: "https://github.com/dotnet/runtime/blob/55e1ac7c07df62c4108d4acedf78f77574470ce5/src/libraries/System.Text.RegularExpressions/tests/FunctionalTests/AttRegexTests.cs#L12-L28", + osiApproved: false, + }, + eGenix: { + name: "eGenix.com Public License 1.1.0", + url: "http://www.egenix.com/products/eGenix.com-Public-License-1.1.0.pdf", + osiApproved: false, + }, + "GCR-docs": { + name: "Gnome GCR Documentation License", + url: "https://github.com/GNOME/gcr/blob/master/docs/COPYING", + osiApproved: false, + }, + AAL: { + name: "Attribution Assurance License", + url: "https://opensource.org/licenses/attribution", + osiApproved: true, + }, + "CAL-1.0": { + name: "Cryptographic Autonomy License 1.0", + url: "http://cryptographicautonomylicense.com/license-text.html", + osiApproved: true, + }, + "PHP-3.0": { + name: "PHP License v3.0", + url: "http://www.php.net/license/3_0.txt", + osiApproved: true, + }, + hdparm: { + name: "hdparm License", + url: "https://github.com/Distrotech/hdparm/blob/4517550db29a91420fb2b020349523b1b4512df2/LICENSE.TXT", + osiApproved: false, + }, + "OpenPBS-2.3": { + name: "OpenPBS v2.3 Software License", + url: "https://github.com/adaptivecomputing/torque/blob/master/PBS_License.txt", + osiApproved: false, + }, + "DL-DE-BY-2.0": { + name: "Data licence Germany – attribution – version 2.0", + url: "https://www.govdata.de/dl-de/by-2-0", + osiApproved: false, + }, + "GFDL-1.3-or-later": { + name: "GNU Free Documentation License v1.3 or later", + url: "https://www.gnu.org/licenses/fdl-1.3.txt", + osiApproved: false, + }, + "CERN-OHL-1.2": { + name: "CERN Open Hardware Licence v1.2", + url: "https://www.ohwr.org/project/licenses/wikis/cern-ohl-v1.2", + osiApproved: false, + }, + MIT: { + name: "MIT License", + url: "https://opensource.org/license/mit/", + osiApproved: true, + }, + XSkat: { + name: "XSkat License", + url: "https://fedoraproject.org/wiki/Licensing/XSkat_License", + osiApproved: false, + }, + Gutmann: { + name: "Gutmann License", + url: "https://www.cs.auckland.ac.nz/~pgut001/dumpasn1.c", + osiApproved: false, + }, + wxWindows: { + name: "wxWindows Library License", + url: "https://opensource.org/licenses/WXwindows", + osiApproved: true, + }, + "CC-BY-NC-SA-2.5": { + name: "Creative Commons Attribution Non Commercial Share Alike 2.5 Generic", + url: "https://creativecommons.org/licenses/by-nc-sa/2.5/legalcode", + osiApproved: false, + }, + "PDDL-1.0": { + name: "Open Data Commons Public Domain Dedication & License 1.0", + url: "http://opendatacommons.org/licenses/pddl/1.0/", + osiApproved: false, + }, + Unlicense: { + name: "The Unlicense", + url: "https://unlicense.org/", + osiApproved: true, + }, + "CUA-OPL-1.0": { + name: "CUA Office Public License v1.0", + url: "https://opensource.org/licenses/CUA-OPL-1.0", + osiApproved: true, + }, + NCL: { + name: "NCL Source Code License", + url: "https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/master/src/modules/module-filter-chain/pffft.c?ref_type=heads#L1-52", + osiApproved: false, + }, + "GFDL-1.1-invariants-or-later": { + name: "GNU Free Documentation License v1.1 or later - invariants", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", + osiApproved: false, + }, + "CECILL-2.1": { + name: "CeCILL Free Software License Agreement v2.1", + url: "http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html", + osiApproved: true, + }, + "PolyForm-Small-Business-1.0.0": { + name: "PolyForm Small Business License 1.0.0", + url: "https://polyformproject.org/licenses/small-business/1.0.0", + osiApproved: false, + }, + "HP-1986": { + name: "Hewlett-Packard 1986 License", + url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/machine/hppa/memchr.S;h=1cca3e5e8867aa4bffef1f75a5c1bba25c0c441e;hb=HEAD#l2", + osiApproved: false, + }, + "HPND-export-US": { + name: "HPND with US Government export control warning", + url: "https://www.kermitproject.org/ck90.html#source", + osiApproved: false, + }, + "X11-swapped": { + name: "X11 swapped final paragraphs", + url: "https://github.com/fedeinthemix/chez-srfi/blob/master/srfi/LICENSE", + osiApproved: false, + }, + "SHL-0.5": { + name: "Solderpad Hardware License v0.5", + url: "https://solderpad.org/licenses/SHL-0.5/", + osiApproved: false, + }, + "BSD-Systemics": { + name: "Systemics BSD variant license", + url: "https://metacpan.org/release/DPARIS/Crypt-DES-2.07/source/COPYRIGHT", + osiApproved: false, + }, + "CDLA-Sharing-1.0": { + name: "Community Data License Agreement Sharing 1.0", + url: "https://cdla.io/sharing-1-0", + osiApproved: false, + }, + "GFDL-1.1-or-later": { + name: "GNU Free Documentation License v1.1 or later", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", + osiApproved: false, + }, + Newsletr: { + name: "Newsletr License", + url: "https://fedoraproject.org/wiki/Licensing/Newsletr", + osiApproved: false, + }, + TMate: { + name: "TMate Open Source License", + url: "http://svnkit.com/license.html", + osiApproved: false, + }, + EPICS: { + name: "EPICS Open License", + url: "https://epics.anl.gov/license/open.php", + osiApproved: false, + }, + "SAX-PD": { + name: "Sax Public Domain Notice", + url: "http://www.saxproject.org/copying.html", + osiApproved: false, + }, + "MIT-Festival": { + name: "MIT Festival Variant", + url: "https://github.com/festvox/flite/blob/master/COPYING", + osiApproved: false, + }, + "LGPL-2.0-or-later": { + name: "GNU Library General Public License v2 or later", + url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", + osiApproved: true, + }, + "QPL-1.0": { + name: "Q Public License 1.0", + url: "http://doc.qt.nokia.com/3.3/license.html", + osiApproved: true, + }, + "SSH-short": { + name: "SSH short notice", + url: "https://github.com/openssh/openssh-portable/blob/1b11ea7c58cd5c59838b5fa574cd456d6047b2d4/pathnames.h", + osiApproved: false, + }, + "OGL-UK-1.0": { + name: "Open Government Licence v1.0", + url: "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/1/", + osiApproved: false, + }, + "GPL-2.0-only": { + name: "GNU General Public License v2.0 only", + url: "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", + osiApproved: true, + }, + "GPL-3.0-with-GCC-exception": { + name: "GNU General Public License v3.0 w/GCC Runtime Library exception", + url: "https://www.gnu.org/licenses/gcc-exception-3.1.html", + osiApproved: true, + }, + "ECL-2.0": { + name: "Educational Community License v2.0", + url: "https://opensource.org/licenses/ECL-2.0", + osiApproved: true, + }, + "CATOSL-1.1": { + name: "Computer Associates Trusted Open Source License 1.1", + url: "https://opensource.org/licenses/CATOSL-1.1", + osiApproved: true, + }, + "Cornell-Lossless-JPEG": { + name: "Cornell Lossless JPEG License", + url: "https://android.googlesource.com/platform/external/dng_sdk/+/refs/heads/master/source/dng_lossless_jpeg.cpp#16", + osiApproved: false, + }, + DOC: { + name: "DOC License", + url: "http://www.cs.wustl.edu/~schmidt/ACE-copying.html", + osiApproved: false, + }, + "RSA-MD": { + name: "RSA Message-Digest License", + url: "http://www.faqs.org/rfcs/rfc1321.html", + osiApproved: false, + }, + "OCLC-2.0": { + name: "OCLC Research Public License 2.0", + url: "http://www.oclc.org/research/activities/software/license/v2final.htm", + osiApproved: true, + }, + "AGPL-3.0-only": { + name: "GNU Affero General Public License v3.0 only", + url: "https://www.gnu.org/licenses/agpl.txt", + osiApproved: true, + }, + "OLDAP-2.5": { + name: "Open LDAP Public License v2.5", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=6852b9d90022e8593c98205413380536b1b5a7cf", + osiApproved: false, + }, + "CC-BY-SA-3.0-DE": { + name: "Creative Commons Attribution Share Alike 3.0 Germany", + url: "https://creativecommons.org/licenses/by-sa/3.0/de/legalcode", + osiApproved: false, + }, + "Artistic-1.0-Perl": { + name: "Artistic License 1.0 (Perl)", + url: "http://dev.perl.org/licenses/artistic.html", + osiApproved: true, + }, + "CC-BY-NC-ND-4.0": { + name: "Creative Commons Attribution Non Commercial No Derivatives 4.0 International", + url: "https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode", + osiApproved: false, + }, + "BSD-3-Clause-No-Nuclear-License-2014": { + name: "BSD 3-Clause No Nuclear License 2014", + url: "https://java.net/projects/javaeetutorial/pages/BerkeleyLicense", + osiApproved: false, + }, + "Martin-Birgmeier": { + name: "Martin Birgmeier License", + url: "https://github.com/Perl/perl5/blob/blead/util.c#L6136", + osiApproved: false, + }, + "EUPL-1.0": { + name: "European Union Public License 1.0", + url: "http://ec.europa.eu/idabc/en/document/7330.html", + osiApproved: false, + }, + "GPL-2.0": { + name: "GNU General Public License v2.0 only", + url: "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", + osiApproved: true, + }, + "McPhee-slideshow": { + name: "McPhee Slideshow License", + url: "https://mirror.las.iastate.edu/tex-archive/graphics/metapost/contrib/macros/slideshow/slideshow.mp", + osiApproved: false, + }, + "CC-BY-NC-ND-1.0": { + name: "Creative Commons Attribution Non Commercial No Derivatives 1.0 Generic", + url: "https://creativecommons.org/licenses/by-nd-nc/1.0/legalcode", + osiApproved: false, + }, + "BlueOak-1.0.0": { + name: "Blue Oak Model License 1.0.0", + url: "https://blueoakcouncil.org/license/1.0.0", + osiApproved: true, + }, + "ODC-By-1.0": { + name: "Open Data Commons Attribution License v1.0", + url: "https://opendatacommons.org/licenses/by/1.0/", + osiApproved: false, + }, + "COIL-1.0": { + name: "Copyfree Open Innovation License", + url: "https://coil.apotheon.org/plaintext/01.0.txt", + osiApproved: false, + }, + "Bitstream-Vera": { + name: "Bitstream Vera Font License", + url: "https://web.archive.org/web/20080207013128/http://www.gnome.org/fonts/", + osiApproved: false, + }, + "JPL-image": { + name: "JPL Image Use Policy", + url: "https://www.jpl.nasa.gov/jpl-image-use-policy", + osiApproved: false, + }, + "MIT-enna": { + name: "enna License", + url: "https://fedoraproject.org/wiki/Licensing/MIT#enna", + osiApproved: false, + }, + "BSD-Inferno-Nettverk": { + name: "BSD-Inferno-Nettverk", + url: "https://www.inet.no/dante/LICENSE", + osiApproved: false, + }, + "CDDL-1.1": { + name: "Common Development and Distribution License 1.1", + url: "http://glassfish.java.net/public/CDDL+GPL_1_1.html", + osiApproved: false, + }, + FSFULLRWD: { + name: "FSF Unlimited License (With License Retention and Warranty Disclaimer)", + url: "https://lists.gnu.org/archive/html/autoconf/2012-04/msg00061.html", + osiApproved: false, + }, + "GFDL-1.2-invariants-only": { + name: "GNU Free Documentation License v1.2 only - invariants", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", + osiApproved: false, + }, + "EFL-1.0": { + name: "Eiffel Forum License v1.0", + url: "http://www.eiffel-nice.org/license/forum.txt", + osiApproved: true, + }, + Entessa: { + name: "Entessa Public License v1.0", + url: "https://opensource.org/licenses/Entessa", + osiApproved: true, + }, + Glide: { + name: "3dfx Glide License", + url: "http://www.users.on.net/~triforce/glidexp/COPYING.txt", + osiApproved: false, + }, + "CC-BY-NC-3.0-DE": { + name: "Creative Commons Attribution Non Commercial 3.0 Germany", + url: "https://creativecommons.org/licenses/by-nc/3.0/de/legalcode", + osiApproved: false, + }, + "Artistic-1.0-cl8": { + name: "Artistic License 1.0 w/clause 8", + url: "https://opensource.org/licenses/Artistic-1.0", + osiApproved: true, + }, + "W3C-19980720": { + name: "W3C Software Notice and License (1998-07-20)", + url: "http://www.w3.org/Consortium/Legal/copyright-software-19980720.html", + osiApproved: false, + }, + "HPND-merchantability-variant": { + name: "Historical Permission Notice and Disclaimer - merchantability variant", + url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/misc/fini.c;hb=HEAD", + osiApproved: false, + }, + Motosoto: { + name: "Motosoto License", + url: "https://opensource.org/licenses/Motosoto", + osiApproved: true, + }, + "OLDAP-1.1": { + name: "Open LDAP Public License v1.1", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=806557a5ad59804ef3a44d5abfbe91d706b0791f", + osiApproved: false, + }, + "HP-1989": { + name: "Hewlett-Packard 1989 License", + url: "https://github.com/bleargh45/Data-UUID/blob/master/LICENSE", + osiApproved: false, + }, + "IEC-Code-Components-EULA": { + name: "IEC Code Components End-user licence agreement", + url: "https://www.iec.ch/webstore/custserv/pdf/CC-EULA.pdf", + osiApproved: false, + }, + "NCGL-UK-2.0": { + name: "Non-Commercial Government Licence", + url: "http://www.nationalarchives.gov.uk/doc/non-commercial-government-licence/version/2/", + osiApproved: false, + }, + "CC-BY-3.0-IGO": { + name: "Creative Commons Attribution 3.0 IGO", + url: "https://creativecommons.org/licenses/by/3.0/igo/legalcode", + osiApproved: false, + }, + "BSD-Source-Code": { + name: "BSD Source Code Attribution", + url: "https://github.com/robbiehanson/CocoaHTTPServer/blob/master/LICENSE.txt", + osiApproved: false, + }, + "GFDL-1.1-no-invariants-only": { + name: "GNU Free Documentation License v1.1 only - no invariants", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", + osiApproved: false, + }, + W3C: { + name: "W3C Software Notice and License (2002-12-31)", + url: "http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231.html", + osiApproved: true, + }, + magaz: { + name: "magaz License", + url: "https://mirrors.nic.cz/tex-archive/macros/latex/contrib/magaz/magaz.tex", + osiApproved: false, + }, + "libutil-David-Nugent": { + name: "libutil David Nugent License", + url: "http://web.mit.edu/freebsd/head/lib/libutil/login_ok.3", + osiApproved: false, + }, + "AFL-2.1": { + name: "Academic Free License v2.1", + url: "http://opensource.linux-mirror.org/licenses/afl-2.1.txt", + osiApproved: true, + }, + "NAIST-2003": { + name: "Nara Institute of Science and Technology License (2003)", + url: "https://enterprise.dejacode.com/licenses/public/naist-2003/#license-text", + osiApproved: false, + }, + "DocBook-XML": { + name: "DocBook XML License", + url: "https://github.com/docbook/xslt10-stylesheets/blob/efd62655c11cc8773708df7a843613fa1e932bf8/xsl/COPYING#L27", + osiApproved: false, + }, + "LiLiQ-Rplus-1.1": { + name: "Licence Libre du Québec – Réciprocité forte version 1.1", + url: "https://www.forge.gouv.qc.ca/participez/licence-logicielle/licence-libre-du-quebec-liliq-en-francais/licence-libre-du-quebec-reciprocite-forte-liliq-r-v1-1/", + osiApproved: true, + }, + "MIT-feh": { + name: "feh License", + url: "https://fedoraproject.org/wiki/Licensing/MIT#feh", + osiApproved: false, + }, + "LGPL-2.1": { + name: "GNU Lesser General Public License v2.1 only", + url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", + osiApproved: true, + }, + "UMich-Merit": { + name: "Michigan/Merit Networks License", + url: "https://github.com/radcli/radcli/blob/master/COPYRIGHT#L64", + osiApproved: false, + }, + "CC-BY-NC-3.0": { + name: "Creative Commons Attribution Non Commercial 3.0 Unported", + url: "https://creativecommons.org/licenses/by-nc/3.0/legalcode", + osiApproved: false, + }, + "GPL-1.0": { + name: "GNU General Public License v1.0 only", + url: "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", + osiApproved: false, + }, + NTP: { + name: "NTP License", + url: "https://opensource.org/licenses/NTP", + osiApproved: true, + }, + "Frameworx-1.0": { + name: "Frameworx Open License 1.0", + url: "https://opensource.org/licenses/Frameworx-1.0", + osiApproved: true, + }, + "BSD-2-Clause-NetBSD": { + name: "BSD 2-Clause NetBSD License", + url: "http://www.netbsd.org/about/redistribution.html#default", + osiApproved: false, + }, + "HPND-sell-variant": { + name: "Historical Permission Notice and Disclaimer - sell variant", + url: "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/net/sunrpc/auth_gss/gss_generic_token.c?h=v4.19", + osiApproved: false, + }, + "CC-BY-1.0": { + name: "Creative Commons Attribution 1.0 Generic", + url: "https://creativecommons.org/licenses/by/1.0/legalcode", + osiApproved: false, + }, + "APL-1.0": { + name: "Adaptive Public License 1.0", + url: "https://opensource.org/licenses/APL-1.0", + osiApproved: true, + }, + WTFPL: { + name: "Do What The F*ck You Want To Public License", + url: "http://www.wtfpl.net/about/", + osiApproved: false, + }, + FBM: { + name: "Fuzzy Bitmap License", + url: "https://github.com/SWI-Prolog/packages-xpce/blob/161a40cd82004f731ba48024f9d30af388a7edf5/src/img/gifwrite.c#L21-L26", + osiApproved: false, + }, + ClArtistic: { + name: "Clarified Artistic License", + url: "http://gianluca.dellavedova.org/2011/01/03/clarified-artistic-license/", + osiApproved: false, + }, + SunPro: { + name: "SunPro License", + url: "https://github.com/freebsd/freebsd-src/blob/main/lib/msun/src/e_acosh.c", + osiApproved: false, + }, + "VSL-1.0": { + name: "Vovida Software License v1.0", + url: "https://opensource.org/licenses/VSL-1.0", + osiApproved: true, + }, + "CC-BY-NC-SA-3.0-IGO": { + name: "Creative Commons Attribution Non Commercial Share Alike 3.0 IGO", + url: "https://creativecommons.org/licenses/by-nc-sa/3.0/igo/legalcode", + osiApproved: false, + }, + "NBPL-1.0": { + name: "Net Boolean Public License v1", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=37b4b3f6cc4bf34e1d3dec61e69914b9819d8894", + osiApproved: false, + }, + "OPUBL-1.0": { + name: "Open Publication License v1.0", + url: "http://opencontent.org/openpub/", + osiApproved: false, + }, + "CC-BY-NC-ND-2.0": { + name: "Creative Commons Attribution Non Commercial No Derivatives 2.0 Generic", + url: "https://creativecommons.org/licenses/by-nc-nd/2.0/legalcode", + osiApproved: false, + }, + "BSD-3-Clause-LBNL": { + name: "Lawrence Berkeley National Labs BSD variant license", + url: "https://fedoraproject.org/wiki/Licensing/LBNLBSD", + osiApproved: true, + }, + Ruby: { + name: "Ruby License", + url: "https://www.ruby-lang.org/en/about/license.txt", + osiApproved: false, + }, + Fair: { + name: "Fair License", + url: "https://web.archive.org/web/20150926120323/http://fairlicense.org/", + osiApproved: true, + }, + "MIT-advertising": { + name: "Enlightenment License (e16)", + url: "https://fedoraproject.org/wiki/Licensing/MIT_With_Advertising", + osiApproved: false, + }, + "OGDL-Taiwan-1.0": { + name: "Taiwan Open Government Data License, version 1.0", + url: "https://data.gov.tw/license", + osiApproved: false, + }, + "OPL-UK-3.0": { + name: "United Kingdom Open Parliament Licence v3.0", + url: "https://www.parliament.uk/site-information/copyright-parliament/open-parliament-licence/", + osiApproved: false, + }, + "MPL-2.0": { + name: "Mozilla Public License 2.0", + url: "https://www.mozilla.org/MPL/2.0/", + osiApproved: true, + }, + "DocBook-Stylesheet": { + name: "DocBook Stylesheet License", + url: "http://www.docbook.org/xml/5.0/docbook-5.0.zip", + osiApproved: false, + }, + "TPL-1.0": { + name: "THOR Public License 1.0", + url: "https://fedoraproject.org/wiki/Licensing:ThorPublicLicense", + osiApproved: false, + }, + "TAPR-OHL-1.0": { + name: "TAPR Open Hardware License v1.0", + url: "https://www.tapr.org/OHL", + osiApproved: false, + }, + UnixCrypt: { + name: "UnixCrypt License", + url: "https://foss.heptapod.net/python-libs/passlib/-/blob/branch/stable/LICENSE#L70", + osiApproved: false, + }, + "FreeBSD-DOC": { + name: "FreeBSD Documentation License", + url: "https://www.freebsd.org/copyright/freebsd-doc-license/", + osiApproved: false, + }, + "CMU-Mach-nodoc": { + name: "CMU Mach - no notices-in-documentation variant", + url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L718-L728", + osiApproved: false, + }, + "CC-BY-3.0-AU": { + name: "Creative Commons Attribution 3.0 Australia", + url: "https://creativecommons.org/licenses/by/3.0/au/legalcode", + osiApproved: false, + }, + "Zimbra-1.4": { + name: "Zimbra Public License v1.4", + url: "http://www.zimbra.com/legal/zimbra-public-license-1-4", + osiApproved: false, + }, + "BSD-3-Clause": { + name: 'BSD 3-Clause "New" or "Revised" License', + url: "https://opensource.org/licenses/BSD-3-Clause", + osiApproved: true, + }, + lsof: { + name: "lsof License", + url: "https://github.com/lsof-org/lsof/blob/master/COPYING", + osiApproved: false, + }, + FreeImage: { + name: "FreeImage Public License v1.0", + url: "http://freeimage.sourceforge.net/freeimage-license.txt", + osiApproved: false, + }, + "OLDAP-2.0": { + name: "Open LDAP Public License v2.0 (or possibly 2.0A and 2.0B)", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=cbf50f4e1185a21abd4c0a54d3f4341fe28f36ea", + osiApproved: false, + }, + "APSL-1.2": { + name: "Apple Public Source License 1.2", + url: "http://www.samurajdata.se/opensource/mirror/licenses/apsl.php", + osiApproved: true, + }, + "APSL-1.0": { + name: "Apple Public Source License 1.0", + url: "https://fedoraproject.org/wiki/Licensing/Apple_Public_Source_License_1.0", + osiApproved: true, + }, + "CC-BY-NC-SA-2.0-FR": { + name: "Creative Commons Attribution-NonCommercial-ShareAlike 2.0 France", + url: "https://creativecommons.org/licenses/by-nc-sa/2.0/fr/legalcode", + osiApproved: false, + }, + "D-FSL-1.0": { + name: "Deutsche Freie Software Lizenz", + url: "http://www.dipp.nrw.de/d-fsl/lizenzen/", + osiApproved: false, + }, + pnmstitch: { + name: "pnmstitch License", + url: "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/editor/pnmstitch.c#l2", + osiApproved: false, + }, + "CC-BY-SA-2.0-UK": { + name: "Creative Commons Attribution Share Alike 2.0 England and Wales", + url: "https://creativecommons.org/licenses/by-sa/2.0/uk/legalcode", + osiApproved: false, + }, + "CERN-OHL-W-2.0": { + name: "CERN Open Hardware Licence Version 2 - Weakly Reciprocal", + url: "https://www.ohwr.org/project/cernohl/wikis/Documents/CERN-OHL-version-2", + osiApproved: true, + }, + "LPL-1.02": { + name: "Lucent Public License v1.02", + url: "http://plan9.bell-labs.com/plan9/license.html", + osiApproved: true, + }, + "CNRI-Jython": { + name: "CNRI Jython License", + url: "http://www.jython.org/license.html", + osiApproved: false, + }, + "BSD-2-Clause-first-lines": { + name: "BSD 2-Clause - first lines requirement", + url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L664-L690", + osiApproved: false, + }, + "BSL-1.0": { + name: "Boost Software License 1.0", + url: "http://www.boost.org/LICENSE_1_0.txt", + osiApproved: true, + }, + "LZMA-SDK-9.11-to-9.20": { + name: "LZMA SDK License (versions 9.11 to 9.20)", + url: "https://www.7-zip.org/sdk.html", + osiApproved: false, + }, + "Condor-1.1": { + name: "Condor Public License v1.1", + url: "http://research.cs.wisc.edu/condor/license.html#condor", + osiApproved: false, + }, + "CC-BY-3.0-US": { + name: "Creative Commons Attribution 3.0 United States", + url: "https://creativecommons.org/licenses/by/3.0/us/legalcode", + osiApproved: false, + }, + "CECILL-C": { + name: "CeCILL-C Free Software License Agreement", + url: "http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html", + osiApproved: false, + }, + diffmark: { + name: "diffmark license", + url: "https://fedoraproject.org/wiki/Licensing/diffmark", + osiApproved: false, + }, + "HPND-Kevlin-Henney": { + name: "Historical Permission Notice and Disclaimer - Kevlin Henney variant", + url: "https://github.com/mruby/mruby/blob/83d12f8d52522cdb7c8cc46fad34821359f453e6/mrbgems/mruby-dir/src/Win/dirent.c#L127-L140", + osiApproved: false, + }, + "GFDL-1.1": { + name: "GNU Free Documentation License v1.1", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", + osiApproved: false, + }, + "StandardML-NJ": { + name: "Standard ML of New Jersey License", + url: "https://www.smlnj.org/license.html", + osiApproved: false, + }, + "RPL-1.1": { + name: "Reciprocal Public License 1.1", + url: "https://opensource.org/licenses/RPL-1.1", + osiApproved: true, + }, + "Hippocratic-2.1": { + name: "Hippocratic License 2.1", + url: "https://firstdonoharm.dev/version/2/1/license.html", + osiApproved: false, + }, + swrule: { + name: "swrule License", + url: "https://ctan.math.utah.edu/ctan/tex-archive/macros/generic/misc/swrule.sty", + osiApproved: false, + }, + "CDDL-1.0": { + name: "Common Development and Distribution License 1.0", + url: "https://opensource.org/licenses/cddl1", + osiApproved: true, + }, + "MS-RL": { + name: "Microsoft Reciprocal License", + url: "http://www.microsoft.com/opensource/licenses.mspx", + osiApproved: true, + }, + "any-OSI-perl-modules": { + name: "Any OSI License - Perl Modules", + url: "https://metacpan.org/release/JUERD/Exporter-Tidy-0.09/view/Tidy.pm#LICENSE", + osiApproved: false, + }, + "CNRI-Python": { + name: "CNRI Python License", + url: "https://opensource.org/licenses/CNRI-Python", + osiApproved: true, + }, + "OLDAP-2.3": { + name: "Open LDAP Public License v2.3", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=d32cf54a32d581ab475d23c810b0a7fbaf8d63c3", + osiApproved: false, + }, + "LiLiQ-P-1.1": { + name: "Licence Libre du Québec – Permissive version 1.1", + url: "https://forge.gouv.qc.ca/licence/fr/liliq-v1-1/", + osiApproved: true, + }, + "Python-2.0.1": { + name: "Python License 2.0.1", + url: "https://www.python.org/download/releases/2.0.1/license/", + osiApproved: false, + }, + MakeIndex: { + name: "MakeIndex License", + url: "https://fedoraproject.org/wiki/Licensing/MakeIndex", + osiApproved: false, + }, + "AFL-1.2": { + name: "Academic Free License v1.2", + url: "http://opensource.linux-mirror.org/licenses/afl-1.2.txt", + osiApproved: true, + }, + "CC-BY-ND-2.0": { + name: "Creative Commons Attribution No Derivatives 2.0 Generic", + url: "https://creativecommons.org/licenses/by-nd/2.0/legalcode", + osiApproved: false, + }, + "FDK-AAC": { + name: "Fraunhofer FDK AAC Codec Library", + url: "https://fedoraproject.org/wiki/Licensing/FDK-AAC", + osiApproved: false, + }, + SL: { + name: "SL License", + url: "https://github.com/mtoyoda/sl/blob/master/LICENSE", + osiApproved: false, + }, + "TU-Berlin-1.0": { + name: "Technische Universitaet Berlin License 1.0", + url: "https://github.com/swh/ladspa/blob/7bf6f3799fdba70fda297c2d8fd9f526803d9680/gsm/COPYRIGHT", + osiApproved: false, + }, + "GPL-1.0+": { + name: "GNU General Public License v1.0 or later", + url: "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", + osiApproved: false, + }, + Saxpath: { + name: "Saxpath License", + url: "https://fedoraproject.org/wiki/Licensing/Saxpath_License", + osiApproved: false, + }, + dvipdfm: { + name: "dvipdfm License", + url: "https://fedoraproject.org/wiki/Licensing/dvipdfm", + osiApproved: false, + }, + "BSD-2-Clause-Darwin": { + name: "BSD 2-Clause - Ian Darwin variant", + url: "https://github.com/file/file/blob/master/COPYING", + osiApproved: false, + }, + "CPAL-1.0": { + name: "Common Public Attribution License 1.0", + url: "https://opensource.org/licenses/CPAL-1.0", + osiApproved: true, + }, + "copyleft-next-0.3.1": { + name: "copyleft-next 0.3.1", + url: "https://github.com/copyleft-next/copyleft-next/blob/master/Releases/copyleft-next-0.3.1", + osiApproved: false, + }, + NetCDF: { + name: "NetCDF license", + url: "http://www.unidata.ucar.edu/software/netcdf/copyright.html", + osiApproved: false, + }, + FTL: { + name: "Freetype Project License", + url: "http://freetype.fis.uniroma2.it/FTL.TXT", + osiApproved: false, + }, + "DocBook-Schema": { + name: "DocBook Schema License", + url: "https://github.com/docbook/xslt10-stylesheets/blob/efd62655c11cc8773708df7a843613fa1e932bf8/xsl/assembly/schema/docbook51b7.rnc", + osiApproved: false, + }, + "CERN-OHL-S-2.0": { + name: "CERN Open Hardware Licence Version 2 - Strongly Reciprocal", + url: "https://www.ohwr.org/project/cernohl/wikis/Documents/CERN-OHL-version-2", + osiApproved: true, + }, + "X11-distribute-modifications-variant": { + name: "X11 License Distribution Modification Variant", + url: "https://github.com/mirror/ncurses/blob/master/COPYING", + osiApproved: false, + }, + "copyleft-next-0.3.0": { + name: "copyleft-next 0.3.0", + url: "https://github.com/copyleft-next/copyleft-next/blob/master/Releases/copyleft-next-0.3.0", + osiApproved: false, + }, + X11: { + name: "X11 License", + url: "http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3", + osiApproved: false, + }, + "CC-BY-NC-SA-2.0-DE": { + name: "Creative Commons Attribution Non Commercial Share Alike 2.0 Germany", + url: "https://creativecommons.org/licenses/by-nc-sa/2.0/de/legalcode", + osiApproved: false, + }, + "GFDL-1.3-only": { + name: "GNU Free Documentation License v1.3 only", + url: "https://www.gnu.org/licenses/fdl-1.3.txt", + osiApproved: false, + }, + Bahyph: { + name: "Bahyph License", + url: "https://fedoraproject.org/wiki/Licensing/Bahyph", + osiApproved: false, + }, + "LGPL-3.0-or-later": { + name: "GNU Lesser General Public License v3.0 or later", + url: "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", + osiApproved: true, + }, + "ZPL-1.1": { + name: "Zope Public License 1.1", + url: "http://old.zope.org/Resources/License/ZPL-1.1", + osiApproved: false, + }, + "gSOAP-1.3b": { + name: "gSOAP Public License v1.3b", + url: "http://www.cs.fsu.edu/~engelen/license.html", + osiApproved: false, + }, + "JasPer-2.0": { + name: "JasPer License", + url: "http://www.ece.uvic.ca/~mdadams/jasper/LICENSE", + osiApproved: false, + }, + "Sendmail-Open-Source-1.1": { + name: "Sendmail Open Source License v1.1", + url: "https://github.com/trusteddomainproject/OpenDMARC/blob/master/LICENSE.Sendmail", + osiApproved: false, + }, + "BUSL-1.1": { + name: "Business Source License 1.1", + url: "https://mariadb.com/bsl11/", + osiApproved: false, + }, + Eurosym: { + name: "Eurosym License", + url: "https://fedoraproject.org/wiki/Licensing/Eurosym", + osiApproved: false, + }, + ThirdEye: { + name: "ThirdEye License", + url: "https://sourceware.org/cgit/binutils-gdb/tree/include/coff/symconst.h#n11", + osiApproved: false, + }, + "CC-SA-1.0": { + name: "Creative Commons Share Alike 1.0 Generic", + url: "https://creativecommons.org/licenses/sa/1.0/legalcode", + osiApproved: false, + }, + "Watcom-1.0": { + name: "Sybase Open Watcom Public License 1.0", + url: "https://opensource.org/licenses/Watcom-1.0", + osiApproved: true, + }, + Caldera: { + name: "Caldera License", + url: "http://www.lemis.com/grog/UNIX/ancient-source-all.pdf", + osiApproved: false, + }, + "Parity-7.0.0": { + name: "The Parity Public License 7.0.0", + url: "https://paritylicense.com/versions/7.0.0.html", + osiApproved: false, + }, + SMPPL: { + name: "Secure Messaging Protocol Public License", + url: "https://github.com/dcblake/SMP/blob/master/Documentation/License.txt", + osiApproved: false, + }, + "AGPL-1.0": { + name: "Affero General Public License v1.0", + url: "http://www.affero.org/oagpl.html", + osiApproved: false, + }, + "MulanPSL-2.0": { + name: "Mulan Permissive Software License, Version 2", + url: "https://license.coscl.org.cn/MulanPSL2", + osiApproved: true, + }, + Afmparse: { + name: "Afmparse License", + url: "https://fedoraproject.org/wiki/Licensing/Afmparse", + osiApproved: false, + }, + "GFDL-1.2-no-invariants-or-later": { + name: "GNU Free Documentation License v1.2 or later - no invariants", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", + osiApproved: false, + }, + "Lucida-Bitmap-Fonts": { + name: "Lucida Bitmap Fonts License", + url: "https://gitlab.freedesktop.org/xorg/font/bh-100dpi/-/blob/master/COPYING?ref_type=heads", + osiApproved: false, + }, + "DRL-1.0": { + name: "Detection Rule License 1.0", + url: "https://github.com/Neo23x0/sigma/blob/master/LICENSE.Detection.Rules.md", + osiApproved: false, + }, + "CC-BY-NC-2.5": { + name: "Creative Commons Attribution Non Commercial 2.5 Generic", + url: "https://creativecommons.org/licenses/by-nc/2.5/legalcode", + osiApproved: false, + }, + GD: { + name: "GD License", + url: "https://libgd.github.io/manuals/2.3.0/files/license-txt.html", + osiApproved: false, + }, + "Zend-2.0": { + name: "Zend License v2.0", + url: "https://web.archive.org/web/20130517195954/http://www.zend.com/license/2_00.txt", + osiApproved: false, + }, + Cronyx: { + name: "Cronyx License", + url: "https://gitlab.freedesktop.org/xorg/font/alias/-/blob/master/COPYING", + osiApproved: false, + }, + TTYP0: { + name: "TTYP0 License", + url: "https://people.mpi-inf.mpg.de/~uwe/misc/uw-ttyp0/", + osiApproved: false, + }, + "CC-BY-ND-1.0": { + name: "Creative Commons Attribution No Derivatives 1.0 Generic", + url: "https://creativecommons.org/licenses/by-nd/1.0/legalcode", + osiApproved: false, + }, + "Ferguson-Twofish": { + name: "Ferguson Twofish License", + url: "https://github.com/wernerd/ZRTPCPP/blob/6b3cd8e6783642292bad0c21e3e5e5ce45ff3e03/cryptcommon/twofish.c#L113C3-L127", + osiApproved: false, + }, + SchemeReport: { + name: "Scheme Language Report License", + osiApproved: false, + }, + "MIT-Khronos-old": { + name: "MIT Khronos - old variant", + url: "https://github.com/KhronosGroup/SPIRV-Cross/blob/main/LICENSES/LicenseRef-KhronosFreeUse.txt", + osiApproved: false, + }, + "LPD-document": { + name: "LPD Documentation License", + url: "https://github.com/Cyan4973/xxHash/blob/dev/doc/xxhash_spec.md", + osiApproved: false, + }, + "UPL-1.0": { + name: "Universal Permissive License v1.0", + url: "https://opensource.org/licenses/UPL", + osiApproved: true, + }, + "CECILL-1.1": { + name: "CeCILL Free Software License Agreement v1.1", + url: "http://www.cecill.info/licences/Licence_CeCILL_V1.1-US.html", + osiApproved: false, + }, + Crossword: { + name: "Crossword License", + url: "https://fedoraproject.org/wiki/Licensing/Crossword", + osiApproved: false, + }, + "C-UDA-1.0": { + name: "Computational Use of Data Agreement v1.0", + url: "https://github.com/microsoft/Computational-Use-of-Data-Agreement/blob/master/C-UDA-1.0.md", + osiApproved: false, + }, + "BSD-3-Clause-HP": { + name: "Hewlett-Packard BSD variant license", + url: "https://github.com/zdohnal/hplip/blob/master/COPYING#L939", + osiApproved: false, + }, + "Apache-1.0": { + name: "Apache License 1.0", + url: "http://www.apache.org/licenses/LICENSE-1.0", + osiApproved: false, + }, + "CERN-OHL-1.1": { + name: "CERN Open Hardware Licence v1.1", + url: "https://www.ohwr.org/project/licenses/wikis/cern-ohl-v1.1", + osiApproved: false, + }, + SISSL: { + name: "Sun Industry Standards Source License v1.1", + url: "http://www.openoffice.org/licenses/sissl_license.html", + osiApproved: true, + }, + "MPL-2.0-no-copyleft-exception": { + name: "Mozilla Public License 2.0 (no copyleft exception)", + url: "https://www.mozilla.org/MPL/2.0/", + osiApproved: true, + }, + "OLFL-1.3": { + name: "Open Logistics Foundation License Version 1.3", + url: "https://openlogisticsfoundation.org/licenses/", + osiApproved: true, + }, + "Inner-Net-2.0": { + name: "Inner Net License v2.0", + url: "https://fedoraproject.org/wiki/Licensing/Inner_Net_License", + osiApproved: false, + }, + "GPL-1.0-only": { + name: "GNU General Public License v1.0 only", + url: "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", + osiApproved: false, + }, + "LiLiQ-R-1.1": { + name: "Licence Libre du Québec – Réciprocité version 1.1", + url: "https://www.forge.gouv.qc.ca/participez/licence-logicielle/licence-libre-du-quebec-liliq-en-francais/licence-libre-du-quebec-reciprocite-liliq-r-v1-1/", + osiApproved: true, + }, + "BSD-4.3TAHOE": { + name: "BSD 4.3 TAHOE License", + url: "https://github.com/389ds/389-ds-base/blob/main/ldap/include/sysexits-compat.h#L15", + osiApproved: false, + }, + "AFL-2.0": { + name: "Academic Free License v2.0", + url: "http://wayback.archive.org/web/20060924134533/http://www.opensource.org/licenses/afl-2.0.txt", + osiApproved: true, + }, + "GFDL-1.2-invariants-or-later": { + name: "GNU Free Documentation License v1.2 or later - invariants", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", + osiApproved: false, + }, + "CC-BY-NC-ND-2.5": { + name: "Creative Commons Attribution Non Commercial No Derivatives 2.5 Generic", + url: "https://creativecommons.org/licenses/by-nc-nd/2.5/legalcode", + osiApproved: false, + }, + "OLDAP-2.4": { + name: "Open LDAP Public License v2.4", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=cd1284c4a91a8a380d904eee68d1583f989ed386", + osiApproved: false, + }, + "Brian-Gladman-3-Clause": { + name: "Brian Gladman 3-Clause License", + url: "https://github.com/SWI-Prolog/packages-clib/blob/master/sha1/brg_endian.h", + osiApproved: false, + }, + gtkbook: { + name: "gtkbook License", + url: "https://github.com/slogan621/gtkbook", + osiApproved: false, + }, + "OFL-1.0-no-RFN": { + name: "SIL Open Font License 1.0 with no Reserved Font Name", + url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL10_web", + osiApproved: false, + }, + "LAL-1.3": { + name: "Licence Art Libre 1.3", + url: "https://artlibre.org/", + osiApproved: false, + }, + threeparttable: { + name: "threeparttable License", + url: "https://fedoraproject.org/wiki/Licensing/Threeparttable", + osiApproved: false, + }, + Imlib2: { + name: "Imlib2 License", + url: "http://trac.enlightenment.org/e/browser/trunk/imlib2/COPYING", + osiApproved: false, + }, + "Adobe-Display-PostScript": { + name: "Adobe Display PostScript License", + url: "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L752", + osiApproved: false, + }, + Xnet: { + name: "X.Net License", + url: "https://opensource.org/licenses/Xnet", + osiApproved: true, + }, + "OSL-2.1": { + name: "Open Software License 2.1", + url: "http://web.archive.org/web/20050212003940/http://www.rosenlaw.com/osl21.htm", + osiApproved: true, + }, + "OLDAP-2.2": { + name: "Open LDAP Public License v2.2", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=470b0c18ec67621c85881b2733057fecf4a1acc3", + osiApproved: false, + }, + "MS-LPL": { + name: "Microsoft Limited Public License", + url: "https://www.openhub.net/licenses/mslpl", + osiApproved: false, + }, + Mup: { + name: "Mup License", + url: "https://fedoraproject.org/wiki/Licensing/Mup", + osiApproved: false, + }, + "LGPL-3.0": { + name: "GNU Lesser General Public License v3.0 only", + url: "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", + osiApproved: true, + }, + "BSD-4.3RENO": { + name: "BSD 4.3 RENO License", + url: "https://sourceware.org/git/?p=binutils-gdb.git;a=blob;f=libiberty/strcasecmp.c;h=131d81c2ce7881fa48c363dc5bf5fb302c61ce0b;hb=HEAD", + osiApproved: false, + }, + "MIT-Click": { + name: "MIT Click License", + url: "https://github.com/kohler/t1utils/blob/master/LICENSE", + osiApproved: false, + }, + "W3C-20150513": { + name: "W3C Software Notice and Document License (2015-05-13)", + url: "https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document", + osiApproved: true, + }, + "GPL-1.0-or-later": { + name: "GNU General Public License v1.0 or later", + url: "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", + osiApproved: false, + }, + "OSL-2.0": { + name: "Open Software License 2.0", + url: "http://web.archive.org/web/20041020171434/http://www.rosenlaw.com/osl2.0.html", + osiApproved: true, + }, + "EPL-2.0": { + name: "Eclipse Public License 2.0", + url: "https://www.eclipse.org/legal/epl-2.0", + osiApproved: true, + }, + "GFDL-1.3": { + name: "GNU Free Documentation License v1.3", + url: "https://www.gnu.org/licenses/fdl-1.3.txt", + osiApproved: false, + }, + "ASWF-Digital-Assets-1.0": { + name: "ASWF Digital Assets License version 1.0", + url: "https://github.com/AcademySoftwareFoundation/foundation/blob/main/digital_assets/aswf_digital_assets_license_v1.0.txt", + osiApproved: false, + }, + "APSL-1.1": { + name: "Apple Public Source License 1.1", + url: "http://www.opensource.apple.com/source/IOSerialFamily/IOSerialFamily-7/APPLE_LICENSE", + osiApproved: true, + }, + HPND: { + name: "Historical Permission Notice and Disclaimer", + url: "https://opensource.org/licenses/HPND", + osiApproved: true, + }, + "Linux-OpenIB": { + name: "Linux Kernel Variant of OpenIB.org license", + url: "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/infiniband/core/sa.h", + osiApproved: false, + }, + Zeeff: { + name: "Zeeff License", + url: "ftp://ftp.tin.org/pub/news/utils/newsx/newsx-1.6.tar.gz", + osiApproved: false, + }, + "OGL-UK-3.0": { + name: "Open Government Licence v3.0", + url: "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/", + osiApproved: false, + }, + "CC-BY-ND-3.0-DE": { + name: "Creative Commons Attribution No Derivatives 3.0 Germany", + url: "https://creativecommons.org/licenses/by-nd/3.0/de/legalcode", + osiApproved: false, + }, + "BSD-4-Clause-Shortened": { + name: "BSD 4 Clause Shortened", + url: "https://metadata.ftp-master.debian.org/changelogs//main/a/arpwatch/arpwatch_2.1a15-7_copyright", + osiApproved: false, + }, + "BSD-2-Clause-FreeBSD": { + name: "BSD 2-Clause FreeBSD License", + url: "http://www.freebsd.org/copyright/freebsd-license.html", + osiApproved: false, + }, + gnuplot: { + name: "gnuplot License", + url: "https://fedoraproject.org/wiki/Licensing/Gnuplot", + osiApproved: false, + }, + "libpng-2.0": { + name: "PNG Reference Library version 2", + url: "http://www.libpng.org/pub/png/src/libpng-LICENSE.txt", + osiApproved: false, + }, + Leptonica: { + name: "Leptonica License", + url: "https://fedoraproject.org/wiki/Licensing/Leptonica", + osiApproved: false, + }, + Clips: { + name: "Clips License", + url: "https://github.com/DrItanium/maya/blob/master/LICENSE.CLIPS", + osiApproved: false, + }, + OpenSSL: { + name: "OpenSSL License", + url: "http://www.openssl.org/source/license.html", + osiApproved: false, + }, + Sendmail: { + name: "Sendmail License", + url: "http://www.sendmail.com/pdfs/open_source/sendmail_license.pdf", + osiApproved: false, + }, + "NCBI-PD": { + name: "NCBI Public Domain Notice", + url: "https://github.com/ncbi/sra-tools/blob/e8e5b6af4edc460156ad9ce5902d0779cffbf685/LICENSE", + osiApproved: false, + }, + TrustedQSL: { + name: "TrustedQSL License", + url: "https://sourceforge.net/p/trustedqsl/tqsl/ci/master/tree/LICENSE.txt", + osiApproved: false, + }, + Catharon: { + name: "Catharon License", + url: "https://github.com/scummvm/scummvm/blob/v2.8.0/LICENSES/CatharonLicense.txt", + osiApproved: false, + }, + "EUPL-1.2": { + name: "European Union Public License 1.2", + url: "https://joinup.ec.europa.eu/page/eupl-text-11-12", + osiApproved: true, + }, + Wsuipa: { + name: "Wsuipa License", + url: "https://fedoraproject.org/wiki/Licensing/Wsuipa", + osiApproved: false, + }, + "OGL-UK-2.0": { + name: "Open Government Licence v2.0", + url: "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/2/", + osiApproved: false, + }, + "ISC-Veillard": { + name: "ISC Veillard variant", + url: "https://raw.githubusercontent.com/GNOME/libxml2/4c2e7c651f6c2f0d1a74f350cbda95f7df3e7017/hash.c", + osiApproved: false, + }, + "CC-BY-3.0-NL": { + name: "Creative Commons Attribution 3.0 Netherlands", + url: "https://creativecommons.org/licenses/by/3.0/nl/legalcode", + osiApproved: false, + }, + "AdaCore-doc": { + name: "AdaCore Doc License", + url: "https://github.com/AdaCore/xmlada/blob/master/docs/index.rst", + osiApproved: false, + }, + "AGPL-1.0-only": { + name: "Affero General Public License v1.0 only", + url: "http://www.affero.org/oagpl.html", + osiApproved: false, + }, + "LGPL-3.0+": { + name: "GNU Lesser General Public License v3.0 or later", + url: "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", + osiApproved: true, + }, + "libselinux-1.0": { + name: "libselinux public domain notice", + url: "https://github.com/SELinuxProject/selinux/blob/master/libselinux/LICENSE", + osiApproved: false, + }, + "HPND-Fenneberg-Livingston": { + name: "Historical Permission Notice and Disclaimer - Fenneberg-Livingston variant", + url: "https://github.com/FreeRADIUS/freeradius-client/blob/master/COPYRIGHT#L32", + osiApproved: false, + }, + "Xdebug-1.03": { + name: "Xdebug License v 1.03", + url: "https://github.com/xdebug/xdebug/blob/master/LICENSE", + osiApproved: false, + }, + Jam: { + name: "Jam License", + url: "https://www.boost.org/doc/libs/1_35_0/doc/html/jam.html", + osiApproved: true, + }, + "GPL-2.0-with-classpath-exception": { + name: "GNU General Public License v2.0 w/Classpath exception", + url: "https://www.gnu.org/software/classpath/license.html", + osiApproved: false, + }, + "check-cvs": { + name: "check-cvs License", + url: "http://cvs.savannah.gnu.org/viewvc/cvs/ccvs/contrib/check_cvs.in?revision=1.1.4.3&view=markup&pathrev=cvs1-11-23#l2", + osiApproved: false, + }, + "LGPL-2.0+": { + name: "GNU Library General Public License v2 or later", + url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", + osiApproved: true, + }, + "AMD-newlib": { + name: "AMD newlib License", + url: "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/sys/a29khif/_close.S;h=04f52ae00de1dafbd9055ad8d73c5c697a3aae7f;hb=HEAD", + osiApproved: false, + }, + "CC-BY-NC-1.0": { + name: "Creative Commons Attribution Non Commercial 1.0 Generic", + url: "https://creativecommons.org/licenses/by-nc/1.0/legalcode", + osiApproved: false, + }, + xinetd: { + name: "xinetd License", + url: "https://fedoraproject.org/wiki/Licensing/Xinetd_License", + osiApproved: false, + }, + "BSD-4-Clause": { + name: 'BSD 4-Clause "Original" or "Old" License', + url: "http://directory.fsf.org/wiki/License:BSD_4Clause", + osiApproved: false, + }, + "IBM-pibs": { + name: "IBM PowerPC Initialization and Boot Software", + url: "http://git.denx.de/?p=u-boot.git;a=blob;f=arch/powerpc/cpu/ppc4xx/miiphy.c;h=297155fdafa064b955e53e9832de93bfb0cfb85b;hb=9fab4bf4cc077c21e43941866f3f2c196f28670d", + osiApproved: false, + }, + "Apache-2.0": { + name: "Apache License 2.0", + url: "https://www.apache.org/licenses/LICENSE-2.0", + osiApproved: true, + }, + "Linux-man-pages-1-para": { + name: "Linux man-pages - 1 paragraph", + url: "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/getcpu.2#n4", + osiApproved: false, + }, + "CPOL-1.02": { + name: "Code Project Open License 1.02", + url: "http://www.codeproject.com/info/cpol10.aspx", + osiApproved: false, + }, + "BSD-Source-beginning-file": { + name: "BSD Source Code Attribution - beginning of file variant", + url: "https://github.com/lattera/freebsd/blob/master/sys/cam/cam.c#L4", + osiApproved: false, + }, + "CERN-OHL-P-2.0": { + name: "CERN Open Hardware Licence Version 2 - Permissive", + url: "https://www.ohwr.org/project/cernohl/wikis/Documents/CERN-OHL-version-2", + osiApproved: true, + }, + OFFIS: { + name: "OFFIS License", + url: "https://sourceforge.net/p/xmedcon/code/ci/master/tree/libs/dicom/README", + osiApproved: false, + }, + "GPL-2.0-or-later": { + name: "GNU General Public License v2.0 or later", + url: "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", + osiApproved: true, + }, + radvd: { + name: "radvd License", + url: "https://github.com/radvd-project/radvd/blob/master/COPYRIGHT", + osiApproved: false, + }, + Xfig: { + name: "Xfig License", + url: "https://github.com/Distrotech/transfig/blob/master/transfig/transfig.c", + osiApproved: false, + }, + Multics: { + name: "Multics License", + url: "https://opensource.org/licenses/Multics", + osiApproved: true, + }, + "AFL-1.1": { + name: "Academic Free License v1.1", + url: "http://opensource.linux-mirror.org/licenses/afl-1.1.txt", + osiApproved: true, + }, + Beerware: { + name: "Beerware License", + url: "https://fedoraproject.org/wiki/Licensing/Beerware", + osiApproved: false, + }, + "MS-PL": { + name: "Microsoft Public License", + url: "http://www.microsoft.com/opensource/licenses.mspx", + osiApproved: true, + }, + "ssh-keyscan": { + name: "ssh-keyscan License", + url: "https://github.com/openssh/openssh-portable/blob/master/LICENCE#L82", + osiApproved: false, + }, + "Spencer-99": { + name: "Spencer License 99", + url: "http://www.opensource.apple.com/source/tcl/tcl-5/tcl/generic/regfronts.c", + osiApproved: false, + }, + "OFL-1.1": { + name: "SIL Open Font License 1.1", + url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web", + osiApproved: true, + }, + Baekmuk: { + name: "Baekmuk License", + url: "https://fedoraproject.org/wiki/Licensing:Baekmuk?rd=Licensing/Baekmuk", + osiApproved: false, + }, + Qhull: { + name: "Qhull License", + url: "https://fedoraproject.org/wiki/Licensing/Qhull", + osiApproved: false, + }, + "GFDL-1.2-or-later": { + name: "GNU Free Documentation License v1.2 or later", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", + osiApproved: false, + }, + "CC-BY-NC-SA-4.0": { + name: "Creative Commons Attribution Non Commercial Share Alike 4.0 International", + url: "https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode", + osiApproved: false, + }, + "APSL-2.0": { + name: "Apple Public Source License 2.0", + url: "http://www.opensource.apple.com/license/apsl/", + osiApproved: true, + }, + VOSTROM: { + name: "VOSTROM Public License for Open Source", + url: "https://fedoraproject.org/wiki/Licensing/VOSTROM", + osiApproved: false, + }, + "Net-SNMP": { + name: "Net-SNMP License", + url: "http://net-snmp.sourceforge.net/about/license.html", + osiApproved: false, + }, + "HPND-doc": { + name: "Historical Permission Notice and Disclaimer - documentation variant", + url: "https://gitlab.freedesktop.org/xorg/lib/libxext/-/blob/master/COPYING?ref_type=heads#L185-197", + osiApproved: false, + }, + NRL: { + name: "NRL License", + url: "http://web.mit.edu/network/isakmp/nrllicense.html", + osiApproved: false, + }, + TPDL: { + name: "Time::ParseDate License", + url: "https://metacpan.org/pod/Time::ParseDate#LICENSE", + osiApproved: false, + }, + "AGPL-1.0-or-later": { + name: "Affero General Public License v1.0 or later", + url: "http://www.affero.org/oagpl.html", + osiApproved: false, + }, + "HPND-Markus-Kuhn": { + name: "Historical Permission Notice and Disclaimer - Markus Kuhn variant", + url: "https://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c", + osiApproved: false, + }, + "LZMA-SDK-9.22": { + name: "LZMA SDK License (versions 9.22 and beyond)", + url: "https://www.7-zip.org/sdk.html", + osiApproved: false, + }, + "Unicode-3.0": { + name: "Unicode License v3", + url: "https://www.unicode.org/license.txt", + osiApproved: true, + }, + "GPL-3.0-or-later": { + name: "GNU General Public License v3.0 or later", + url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html", + osiApproved: true, + }, + "OpenSSL-standalone": { + name: "OpenSSL License - standalone", + url: "https://library.netapp.com/ecm/ecm_download_file/ECMP1196395", + osiApproved: false, + }, + "Zimbra-1.3": { + name: "Zimbra Public License v1.3", + url: "http://web.archive.org/web/20100302225219/http://www.zimbra.com/license/zimbra-public-license-1-3.html", + osiApproved: false, + }, + "xkeyboard-config-Zinoviev": { + name: "xkeyboard-config Zinoviev License", + url: "https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/blob/master/COPYING?ref_type=heads#L178", + osiApproved: false, + }, + "GFDL-1.1-invariants-only": { + name: "GNU Free Documentation License v1.1 only - invariants", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", + osiApproved: false, + }, + OML: { + name: "Open Market License", + url: "https://fedoraproject.org/wiki/Licensing/Open_Market_License", + osiApproved: false, + }, + "ANTLR-PD": { + name: "ANTLR Software Rights Notice", + url: "http://www.antlr2.org/license.html", + osiApproved: false, + }, + "HPND-MIT-disclaimer": { + name: "Historical Permission Notice and Disclaimer with MIT disclaimer", + url: "https://metacpan.org/release/NLNETLABS/Net-DNS-SEC-1.22/source/LICENSE", + osiApproved: false, + }, + Dotseqn: { + name: "Dotseqn License", + url: "https://fedoraproject.org/wiki/Licensing/Dotseqn", + osiApproved: false, + }, + "HPND-DEC": { + name: "Historical Permission Notice and Disclaimer - DEC variant", + url: "https://gitlab.freedesktop.org/xorg/app/xkbcomp/-/blob/master/COPYING?ref_type=heads#L69", + osiApproved: false, + }, + "LGPL-2.0-only": { + name: "GNU Library General Public License v2 only", + url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", + osiApproved: true, + }, + "CC-BY-2.5-AU": { + name: "Creative Commons Attribution 2.5 Australia", + url: "https://creativecommons.org/licenses/by/2.5/au/legalcode", + osiApproved: false, + }, + "DEC-3-Clause": { + name: "DEC 3-Clause License", + url: "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L239", + osiApproved: false, + }, + "QPL-1.0-INRIA-2004": { + name: "Q Public License 1.0 - INRIA 2004 variant", + url: "https://github.com/maranget/hevea/blob/master/LICENSE", + osiApproved: false, + }, + Intel: { + name: "Intel Open Source License", + url: "https://opensource.org/licenses/Intel", + osiApproved: true, + }, + "NIST-PD-fallback": { + name: "NIST Public Domain Notice with license fallback", + url: "https://github.com/usnistgov/jsip/blob/59700e6926cbe96c5cdae897d9a7d2656b42abe3/LICENSE", + osiApproved: false, + }, + "CC-BY-NC-4.0": { + name: "Creative Commons Attribution Non Commercial 4.0 International", + url: "https://creativecommons.org/licenses/by-nc/4.0/legalcode", + osiApproved: false, + }, + "BSD-3-Clause-No-Nuclear-Warranty": { + name: "BSD 3-Clause No Nuclear Warranty", + url: "https://jogamp.org/git/?p=gluegen.git;a=blob_plain;f=LICENSE.txt", + osiApproved: false, + }, + "HPND-UC": { + name: "Historical Permission Notice and Disclaimer - University of California variant", + url: "https://core.tcl-lang.org/tk/file?name=compat/unistd.h", + osiApproved: false, + }, + "MIT-Wu": { + name: "MIT Tom Wu Variant", + url: "https://github.com/chromium/octane/blob/master/crypto.js", + osiApproved: false, + }, + Kastrup: { + name: "Kastrup License", + url: "https://ctan.math.utah.edu/ctan/tex-archive/macros/generic/kastrup/binhex.dtx", + osiApproved: false, + }, + "MIT-CMU": { + name: "CMU License", + url: "https://fedoraproject.org/wiki/Licensing:MIT?rd=Licensing/MIT#CMU_Style", + osiApproved: false, + }, + "DL-DE-ZERO-2.0": { + name: "Data licence Germany – zero – version 2.0", + url: "https://www.govdata.de/dl-de/zero-2-0", + osiApproved: false, + }, + "NIST-Software": { + name: "NIST Software License", + url: "https://github.com/open-quantum-safe/liboqs/blob/40b01fdbb270f8614fde30e65d30e9da18c02393/src/common/rand/rand_nist.c#L1-L15", + osiApproved: false, + }, + "Spencer-94": { + name: "Spencer License 94", + url: "https://fedoraproject.org/wiki/Licensing/Henry_Spencer_Reg-Ex_Library_License", + osiApproved: false, + }, + "CC-BY-2.0": { + name: "Creative Commons Attribution 2.0 Generic", + url: "https://creativecommons.org/licenses/by/2.0/legalcode", + osiApproved: false, + }, + "EUPL-1.1": { + name: "European Union Public License 1.1", + url: "https://joinup.ec.europa.eu/software/page/eupl/licence-eupl", + osiApproved: true, + }, + "HPND-export-US-modify": { + name: "HPND with US Government export control warning and modification rqmt", + url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L1157-L1182", + osiApproved: false, + }, + "generic-xts": { + name: "Generic XTS License", + url: "https://github.com/mhogomchungu/zuluCrypt/blob/master/external_libraries/tcplay/generic_xts.c", + osiApproved: false, + }, + NLPL: { + name: "No Limit Public License", + url: "https://fedoraproject.org/wiki/Licensing/NLPL", + osiApproved: false, + }, + NCSA: { + name: "University of Illinois/NCSA Open Source License", + url: "http://otm.illinois.edu/uiuc_openSource", + osiApproved: true, + }, + "PSF-2.0": { + name: "Python Software Foundation License 2.0", + url: "https://opensource.org/licenses/Python-2.0", + osiApproved: false, + }, + "Linux-man-pages-copyleft-var": { + name: "Linux man-pages Copyleft Variant", + url: "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/set_mempolicy.2#n5", + osiApproved: false, + }, + "OSL-1.1": { + name: "Open Software License 1.1", + url: "https://fedoraproject.org/wiki/Licensing/OSL1.1", + osiApproved: false, + }, + "mpi-permissive": { + name: "mpi Permissive License", + url: "https://sources.debian.org/src/openmpi/4.1.0-10/ompi/debuggers/msgq_interface.h/?hl=19#L19", + osiApproved: false, + }, + Glulxe: { + name: "Glulxe License", + url: "https://fedoraproject.org/wiki/Licensing/Glulxe", + osiApproved: false, + }, + "LAL-1.2": { + name: "Licence Art Libre 1.2", + url: "http://artlibre.org/licence/lal/licence-art-libre-12/", + osiApproved: false, + }, + "SMAIL-GPL": { + name: "SMAIL General Public License", + url: "https://sources.debian.org/copyright/license/debianutils/4.11.2/", + osiApproved: false, + }, + "NASA-1.3": { + name: "NASA Open Source Agreement 1.3", + url: "http://ti.arc.nasa.gov/opensource/nosa/", + osiApproved: true, + }, + "SPL-1.0": { + name: "Sun Public License v1.0", + url: "https://opensource.org/licenses/SPL-1.0", + osiApproved: true, + }, + "BSD-Advertising-Acknowledgement": { + name: "BSD Advertising Acknowledgement License", + url: "https://github.com/python-excel/xlrd/blob/master/LICENSE#L33", + osiApproved: false, + }, + "BSD-3-Clause-Modification": { + name: "BSD 3-Clause Modification", + url: "https://fedoraproject.org/wiki/Licensing:BSD#Modification_Variant", + osiApproved: false, + }, + "3D-Slicer-1.0": { + name: "3D Slicer License v1.0", + url: "https://slicer.org/LICENSE", + osiApproved: false, + }, + "NPL-1.1": { + name: "Netscape Public License v1.1", + url: "http://www.mozilla.org/MPL/NPL/1.1/", + osiApproved: false, + }, + "GPL-2.0-with-GCC-exception": { + name: "GNU General Public License v2.0 w/GCC Runtime Library exception", + url: "https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=gcc/libgcc1.c;h=762f5143fc6eed57b6797c82710f3538aa52b40b;hb=cb143a3ce4fb417c68f5fa2691a1b1b1053dfba9#l10", + osiApproved: false, + }, + "IJG-short": { + name: "Independent JPEG Group License - short", + url: "https://sourceforge.net/p/xmedcon/code/ci/master/tree/libs/ljpg/", + osiApproved: false, + }, + "CC-BY-4.0": { + name: "Creative Commons Attribution 4.0 International", + url: "https://creativecommons.org/licenses/by/4.0/legalcode", + osiApproved: false, + }, + ulem: { + name: "ulem License", + url: "https://mirrors.ctan.org/macros/latex/contrib/ulem/README", + osiApproved: false, + }, + "BSD-3-Clause-Sun": { + name: "BSD 3-Clause Sun Microsystems", + url: "https://github.com/xmlark/msv/blob/b9316e2f2270bc1606952ea4939ec87fbba157f3/xsdlib/src/main/java/com/sun/msv/datatype/regexp/InternalImpl.java", + osiApproved: false, + }, + "SAX-PD-2.0": { + name: "Sax Public Domain Notice 2.0", + url: "http://www.saxproject.org/copying.html", + osiApproved: false, + }, + "TORQUE-1.1": { + name: "TORQUE v2.5+ Software License v1.1", + url: "https://fedoraproject.org/wiki/Licensing/TORQUEv1.1", + osiApproved: false, + }, + "TU-Berlin-2.0": { + name: "Technische Universitaet Berlin License 2.0", + url: "https://github.com/CorsixTH/deps/blob/fd339a9f526d1d9c9f01ccf39e438a015da50035/licences/libgsm.txt", + osiApproved: false, + }, + Borceux: { + name: "Borceux license", + url: "https://fedoraproject.org/wiki/Licensing/Borceux", + osiApproved: false, + }, + "GPL-3.0+": { + name: "GNU General Public License v3.0 or later", + url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html", + osiApproved: true, + }, + "0BSD": { + name: "BSD Zero Clause License", + url: "http://landley.net/toybox/license.html", + osiApproved: true, + }, + "Mackerras-3-Clause": { + name: "Mackerras 3-Clause License", + url: "https://github.com/ppp-project/ppp/blob/master/pppd/chap_ms.c#L6-L28", + osiApproved: false, + }, + "GFDL-1.3-invariants-or-later": { + name: "GNU Free Documentation License v1.3 or later - invariants", + url: "https://www.gnu.org/licenses/fdl-1.3.txt", + osiApproved: false, + }, + "Knuth-CTAN": { + name: "Knuth CTAN License", + url: "https://ctan.org/license/knuth", + osiApproved: false, + }, + SMLNJ: { + name: "Standard ML of New Jersey License", + url: "https://www.smlnj.org/license.html", + osiApproved: false, + }, + "NPOSL-3.0": { + name: "Non-Profit Open Software License 3.0", + url: "https://opensource.org/licenses/NOSL3.0", + osiApproved: true, + }, + "OLDAP-1.4": { + name: "Open LDAP Public License v1.4", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=c9f95c2f3f2ffb5e0ae55fe7388af75547660941", + osiApproved: false, + }, + "Intel-ACPI": { + name: "Intel ACPI Software License Agreement", + url: "https://fedoraproject.org/wiki/Licensing/Intel_ACPI_Software_License_Agreement", + osiApproved: false, + }, + "Adobe-Glyph": { + name: "Adobe Glyph List License", + url: "https://fedoraproject.org/wiki/Licensing/MIT#AdobeGlyph", + osiApproved: false, + }, + "BSD-3-Clause-Attribution": { + name: "BSD with attribution", + url: "https://fedoraproject.org/wiki/Licensing/BSD_with_Attribution", + osiApproved: false, + }, + metamail: { + name: "metamail License", + url: "https://github.com/Dual-Life/mime-base64/blob/master/Base64.xs#L12", + osiApproved: false, + }, + Zed: { + name: "Zed License", + url: "https://fedoraproject.org/wiki/Licensing/Zed", + osiApproved: false, + }, + "Sun-PPP-2000": { + name: "Sun PPP License (2000)", + url: "https://github.com/ppp-project/ppp/blob/master/modules/ppp_ahdlc.c#L7-L19", + osiApproved: false, + }, + "SGI-B-1.0": { + name: "SGI Free Software License B v1.0", + url: "http://oss.sgi.com/projects/FreeB/SGIFreeSWLicB.1.0.html", + osiApproved: false, + }, + xlock: { + name: "xlock License", + url: "https://fossies.org/linux/tiff/contrib/ras/ras2tif.c", + osiApproved: false, + }, + "AGPL-3.0": { + name: "GNU Affero General Public License v3.0", + url: "https://www.gnu.org/licenses/agpl.txt", + osiApproved: true, + }, + SCEA: { + name: "SCEA Shared Source License", + url: "http://research.scea.com/scea_shared_source_license.html", + osiApproved: false, + }, + "Artistic-2.0": { + name: "Artistic License 2.0", + url: "http://www.perlfoundation.org/artistic_license_2_0", + osiApproved: true, + }, + ICU: { + name: "ICU License", + url: "http://source.icu-project.org/repos/icu/icu/trunk/license.html", + osiApproved: true, + }, + "CC-BY-2.5": { + name: "Creative Commons Attribution 2.5 Generic", + url: "https://creativecommons.org/licenses/by/2.5/legalcode", + osiApproved: false, + }, + "SHL-0.51": { + name: "Solderpad Hardware License, Version 0.51", + url: "https://solderpad.org/licenses/SHL-0.51/", + osiApproved: false, + }, + "LPPL-1.3a": { + name: "LaTeX Project Public License v1.3a", + url: "http://www.latex-project.org/lppl/lppl-1-3a.txt", + osiApproved: false, + }, + "CDLA-Permissive-1.0": { + name: "Community Data License Agreement Permissive 1.0", + url: "https://cdla.io/permissive-1-0", + osiApproved: false, + }, + "EFL-2.0": { + name: "Eiffel Forum License v2.0", + url: "http://www.eiffel-nice.org/license/eiffel-forum-license-2.html", + osiApproved: true, + }, + "URT-RLE": { + name: "Utah Raster Toolkit Run Length Encoded License", + url: "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/converter/other/pnmtorle.c", + osiApproved: false, + }, + "HPND-sell-regexpr": { + name: "Historical Permission Notice and Disclaimer - sell regexpr variant", + url: "https://gitlab.com/bacula-org/bacula/-/blob/Branch-11.0/bacula/LICENSE-FOSS?ref_type=heads#L245", + osiApproved: false, + }, + "GFDL-1.3-no-invariants-or-later": { + name: "GNU Free Documentation License v1.3 or later - no invariants", + url: "https://www.gnu.org/licenses/fdl-1.3.txt", + osiApproved: false, + }, + AMDPLPA: { + name: "AMD's plpa_map.c License", + url: "https://fedoraproject.org/wiki/Licensing/AMD_plpa_map_License", + osiApproved: false, + }, + "Bitstream-Charter": { + name: "Bitstream Charter Font License", + url: "https://fedoraproject.org/wiki/Licensing/Charter#License_Text", + osiApproved: false, + }, + "python-ldap": { + name: "Python ldap License", + url: "https://github.com/python-ldap/python-ldap/blob/main/LICENCE", + osiApproved: false, + }, + "CC-BY-SA-3.0-AT": { + name: "Creative Commons Attribution Share Alike 3.0 Austria", + url: "https://creativecommons.org/licenses/by-sa/3.0/at/legalcode", + osiApproved: false, + }, + "OGC-1.0": { + name: "OGC Software License, Version 1.0", + url: "https://www.ogc.org/ogc/software/1.0", + osiApproved: false, + }, + "CC-BY-SA-2.0": { + name: "Creative Commons Attribution Share Alike 2.0 Generic", + url: "https://creativecommons.org/licenses/by-sa/2.0/legalcode", + osiApproved: false, + }, + PADL: { + name: "PADL License", + url: "https://git.openldap.org/openldap/openldap/-/blob/master/libraries/libldap/os-local.c?ref_type=heads#L19-23", + osiApproved: false, + }, + "NICTA-1.0": { + name: "NICTA Public Software License, Version 1.0", + url: "https://opensource.apple.com/source/mDNSResponder/mDNSResponder-320.10/mDNSPosix/nss_ReadMe.txt", + osiApproved: false, + }, + "LPL-1.0": { + name: "Lucent Public License Version 1.0", + url: "https://opensource.org/licenses/LPL-1.0", + osiApproved: true, + }, + "LPPL-1.1": { + name: "LaTeX Project Public License v1.1", + url: "http://www.latex-project.org/lppl/lppl-1-1.txt", + osiApproved: false, + }, + "CDL-1.0": { + name: "Common Documentation License 1.0", + url: "http://www.opensource.apple.com/cdl/", + osiApproved: false, + }, + "Boehm-GC": { + name: "Boehm-Demers-Weiser GC License", + url: "https://fedoraproject.org/wiki/Licensing:MIT#Another_Minimal_variant_(found_in_libatomic_ops)", + osiApproved: false, + }, + "Sun-PPP": { + name: "Sun PPP License", + url: "https://github.com/ppp-project/ppp/blob/master/pppd/eap.c#L7-L16", + osiApproved: false, + }, + "OLDAP-2.2.1": { + name: "Open LDAP Public License v2.2.1", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=4bc786f34b50aa301be6f5600f58a980070f481e", + osiApproved: false, + }, + "AGPL-3.0-or-later": { + name: "GNU Affero General Public License v3.0 or later", + url: "https://www.gnu.org/licenses/agpl.txt", + osiApproved: true, + }, + "OLDAP-2.6": { + name: "Open LDAP Public License v2.6", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=1cae062821881f41b73012ba816434897abf4205", + osiApproved: false, + }, + "BSD-3-Clause-No-Nuclear-License": { + name: "BSD 3-Clause No Nuclear License", + url: "http://download.oracle.com/otn-pub/java/licenses/bsd.txt", + osiApproved: false, + }, + "BSD-Protection": { + name: "BSD Protection License", + url: "https://fedoraproject.org/wiki/Licensing/BSD_Protection_License", + osiApproved: false, + }, + "OCCT-PL": { + name: "Open CASCADE Technology Public License", + url: "http://www.opencascade.com/content/occt-public-license", + osiApproved: false, + }, + "GPL-2.0-with-font-exception": { + name: "GNU General Public License v2.0 w/Font exception", + url: "https://www.gnu.org/licenses/gpl-faq.html#FontException", + osiApproved: false, + }, + "YPL-1.0": { + name: "Yahoo! Public License v1.0", + url: "http://www.zimbra.com/license/yahoo_public_license_1.0.html", + osiApproved: false, + }, + MIPS: { + name: "MIPS License", + url: "https://sourceware.org/cgit/binutils-gdb/tree/include/coff/sym.h#n11", + osiApproved: false, + }, + "SGI-B-2.0": { + name: "SGI Free Software License B v2.0", + url: "http://oss.sgi.com/projects/FreeB/SGIFreeSWLicB.2.0.pdf", + osiApproved: false, + }, + "MIT-open-group": { + name: "MIT Open Group variant", + url: "https://gitlab.freedesktop.org/xorg/app/iceauth/-/blob/master/COPYING", + osiApproved: false, + }, + AML: { + name: "Apple MIT License", + url: "https://fedoraproject.org/wiki/Licensing/Apple_MIT_License", + osiApproved: false, + }, + "OSL-1.0": { + name: "Open Software License 1.0", + url: "https://opensource.org/licenses/OSL-1.0", + osiApproved: true, + }, + "GFDL-1.3-invariants-only": { + name: "GNU Free Documentation License v1.3 only - invariants", + url: "https://www.gnu.org/licenses/fdl-1.3.txt", + osiApproved: false, + }, + "bzip2-1.0.5": { + name: "bzip2 and libbzip2 License v1.0.5", + url: "https://sourceware.org/bzip2/1.0.5/bzip2-manual-1.0.5.html", + osiApproved: false, + }, + Symlinks: { + name: "Symlinks License", + url: "https://www.mail-archive.com/debian-bugs-rc@lists.debian.org/msg11494.html", + osiApproved: false, + }, + "Ruby-pty": { + name: "Ruby pty extension license", + url: "https://github.com/ruby/ruby/blob/9f6deaa6888a423720b4b127b5314f0ad26cc2e6/ext/pty/pty.c#L775-L786", + osiApproved: false, + }, + UCAR: { + name: "UCAR License", + url: "https://github.com/Unidata/UDUNITS-2/blob/master/COPYRIGHT", + osiApproved: false, + }, + "SimPL-2.0": { + name: "Simple Public License 2.0", + url: "https://opensource.org/licenses/SimPL-2.0", + osiApproved: true, + }, + "PolyForm-Noncommercial-1.0.0": { + name: "PolyForm Noncommercial License 1.0.0", + url: "https://polyformproject.org/licenses/noncommercial/1.0.0", + osiApproved: false, + }, + "OFL-1.1-no-RFN": { + name: "SIL Open Font License 1.1 with no Reserved Font Name", + url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web", + osiApproved: true, + }, + Furuseth: { + name: "Furuseth License", + url: "https://git.openldap.org/openldap/openldap/-/blob/master/COPYRIGHT?ref_type=heads#L39-51", + osiApproved: false, + }, + "Mackerras-3-Clause-acknowledgment": { + name: "Mackerras 3-Clause - acknowledgment variant", + url: "https://github.com/ppp-project/ppp/blob/master/pppd/auth.c#L6-L28", + osiApproved: false, + }, + "CC-PDM-1.0": { + name: "Creative Commons Public Domain Mark 1.0 Universal", + url: "https://creativecommons.org/publicdomain/mark/1.0/", + osiApproved: false, + }, + "LGPL-2.1+": { + name: "GNU Lesser General Public License v2.1 or later", + url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", + osiApproved: true, + }, + Zlib: { + name: "zlib License", + url: "http://www.zlib.net/zlib_license.html", + osiApproved: true, + }, + "BSD-2-Clause-Views": { + name: "BSD 2-Clause with views sentence", + url: "http://www.freebsd.org/copyright/freebsd-license.html", + osiApproved: false, + }, + "Interbase-1.0": { + name: "Interbase Public License v1.0", + url: "https://web.archive.org/web/20060319014854/http://info.borland.com/devsupport/interbase/opensource/IPL.html", + osiApproved: false, + }, + "LGPL-2.0": { + name: "GNU Library General Public License v2 only", + url: "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", + osiApproved: true, + }, + "LGPL-3.0-only": { + name: "GNU Lesser General Public License v3.0 only", + url: "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", + osiApproved: true, + }, + "CC-BY-NC-SA-3.0": { + name: "Creative Commons Attribution Non Commercial Share Alike 3.0 Unported", + url: "https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode", + osiApproved: false, + }, + "MIT-Modern-Variant": { + name: "MIT License Modern Variant", + url: "https://fedoraproject.org/wiki/Licensing:MIT#Modern_Variants", + osiApproved: true, + }, + "Unicode-TOU": { + name: "Unicode Terms of Use", + url: "http://web.archive.org/web/20140704074106/http://www.unicode.org/copyright.html", + osiApproved: false, + }, + APAFML: { + name: "Adobe Postscript AFM License", + url: "https://fedoraproject.org/wiki/Licensing/AdobePostscriptAFM", + osiApproved: false, + }, + TCL: { + name: "TCL/TK License", + url: "http://www.tcl.tk/software/tcltk/license.html", + osiApproved: false, + }, + Xerox: { + name: "Xerox License", + url: "https://fedoraproject.org/wiki/Licensing/Xerox", + osiApproved: false, + }, + FSFUL: { + name: "FSF Unlimited License", + url: "https://fedoraproject.org/wiki/Licensing/FSF_Unlimited_License", + osiApproved: false, + }, + "FSFAP-no-warranty-disclaimer": { + name: "FSF All Permissive License (without Warranty)", + url: "https://git.savannah.gnu.org/cgit/wget.git/tree/util/trunc.c?h=v1.21.3&id=40747a11e44ced5a8ac628a41f879ced3e2ebce9#n6", + osiApproved: false, + }, + "Artistic-1.0": { + name: "Artistic License 1.0", + url: "https://opensource.org/licenses/Artistic-1.0", + osiApproved: true, + }, + ImageMagick: { + name: "ImageMagick License", + url: "http://www.imagemagick.org/script/license.php", + osiApproved: false, + }, + "Brian-Gladman-2-Clause": { + name: "Brian Gladman 2-Clause License", + url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L140-L156", + osiApproved: false, + }, + "BitTorrent-1.1": { + name: "BitTorrent Open Source License v1.1", + url: "http://directory.fsf.org/wiki/License:BitTorrentOSL1.1", + osiApproved: false, + }, + "GPL-3.0-only": { + name: "GNU General Public License v3.0 only", + url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html", + osiApproved: true, + }, + "Linux-man-pages-copyleft": { + name: "Linux man-pages Copyleft", + url: "https://www.kernel.org/doc/man-pages/licenses.html", + osiApproved: false, + }, + "NTP-0": { + name: "NTP No Attribution", + url: "https://github.com/tytso/e2fsprogs/blob/master/lib/et/et_name.c", + osiApproved: false, + }, + curl: { + name: "curl License", + url: "https://github.com/bagder/curl/blob/master/COPYING", + osiApproved: false, + }, + MITNFA: { + name: "MIT +no-false-attribs license", + url: "https://fedoraproject.org/wiki/Licensing/MITNFA", + osiApproved: false, + }, + libtiff: { + name: "libtiff License", + url: "https://fedoraproject.org/wiki/Licensing/libtiff", + osiApproved: false, + }, + "ErlPL-1.1": { + name: "Erlang Public License v1.1", + url: "http://www.erlang.org/EPLICENSE", + osiApproved: false, + }, + "Adobe-Utopia": { + name: "Adobe Utopia Font License", + url: "https://gitlab.freedesktop.org/xorg/font/adobe-utopia-100dpi/-/blob/master/COPYING?ref_type=heads", + osiApproved: false, + }, + HaskellReport: { + name: "Haskell Language Report License", + url: "https://fedoraproject.org/wiki/Licensing/Haskell_Language_Report_License", + osiApproved: false, + }, + ISC: { + name: "ISC License", + url: "https://www.isc.org/licenses/", + osiApproved: true, + }, + Naumen: { + name: "Naumen Public License", + url: "https://opensource.org/licenses/Naumen", + osiApproved: true, + }, + "CC-BY-SA-1.0": { + name: "Creative Commons Attribution Share Alike 1.0 Generic", + url: "https://creativecommons.org/licenses/by-sa/1.0/legalcode", + osiApproved: false, + }, + "etalab-2.0": { + name: "Etalab Open License 2.0", + url: "https://github.com/DISIC/politique-de-contribution-open-source/blob/master/LICENSE.pdf", + osiApproved: false, + }, + "MPEG-SSG": { + name: "MPEG Software Simulation", + url: "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/converter/ppm/ppmtompeg/jrevdct.c#l1189", + osiApproved: false, + }, + CFITSIO: { + name: "CFITSIO License", + url: "https://heasarc.gsfc.nasa.gov/docs/software/fitsio/c/f_user/node9.html", + osiApproved: false, + }, + "MulanPSL-1.0": { + name: "Mulan Permissive Software License, Version 1", + url: "https://license.coscl.org.cn/MulanPSL/", + osiApproved: false, + }, + "GPL-2.0+": { + name: "GNU General Public License v2.0 or later", + url: "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", + osiApproved: true, + }, + "BSD-2-Clause-Patent": { + name: "BSD-2-Clause Plus Patent License", + url: "https://opensource.org/licenses/BSDplusPatent", + osiApproved: true, + }, + "CC-PDDC": { + name: "Creative Commons Public Domain Dedication and Certification", + url: "https://creativecommons.org/licenses/publicdomain/", + osiApproved: false, + }, + "TGPPL-1.0": { + name: "Transitive Grace Period Public Licence 1.0", + url: "https://fedoraproject.org/wiki/Licensing/TGPPL", + osiApproved: false, + }, + snprintf: { + name: "snprintf License", + url: "https://github.com/openssh/openssh-portable/blob/master/openbsd-compat/bsd-snprintf.c#L2", + osiApproved: false, + }, + Nunit: { + name: "Nunit License", + url: "https://fedoraproject.org/wiki/Licensing/Nunit", + osiApproved: false, + }, + "Boehm-GC-without-fee": { + name: "Boehm-Demers-Weiser GC License (without fee)", + url: "https://github.com/MariaDB/server/blob/11.6/libmysqld/lib_sql.cc", + osiApproved: false, + }, + Pixar: { + name: "Pixar License", + url: "https://github.com/PixarAnimationStudios/OpenSubdiv/raw/v3_5_0/LICENSE.txt", + osiApproved: false, + }, + "HPND-Netrek": { + name: "Historical Permission Notice and Disclaimer - Netrek variant", + osiApproved: false, + }, + Minpack: { + name: "Minpack License", + url: "http://www.netlib.org/minpack/disclaimer", + osiApproved: false, + }, + "GFDL-1.1-only": { + name: "GNU Free Documentation License v1.1 only", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", + osiApproved: false, + }, + "HPND-INRIA-IMAG": { + name: "Historical Permission Notice and Disclaimer - INRIA-IMAG variant", + url: "https://github.com/ppp-project/ppp/blob/master/pppd/ipv6cp.c#L75-L83", + osiApproved: false, + }, + "App-s2p": { + name: "App::s2p License", + url: "https://fedoraproject.org/wiki/Licensing/App-s2p", + osiApproved: false, + }, + "BSD-3-Clause-acpica": { + name: "BSD 3-Clause acpica variant", + url: "https://github.com/acpica/acpica/blob/master/source/common/acfileio.c#L119", + osiApproved: false, + }, + OGTSL: { + name: "Open Group Test Suite License", + url: "http://www.opengroup.org/testing/downloads/The_Open_Group_TSL.txt", + osiApproved: true, + }, + "ODbL-1.0": { + name: "Open Data Commons Open Database License v1.0", + url: "http://www.opendatacommons.org/licenses/odbl/1.0/", + osiApproved: false, + }, + "CC-BY-ND-3.0": { + name: "Creative Commons Attribution No Derivatives 3.0 Unported", + url: "https://creativecommons.org/licenses/by-nd/3.0/legalcode", + osiApproved: false, + }, + "CC-BY-SA-2.5": { + name: "Creative Commons Attribution Share Alike 2.5 Generic", + url: "https://creativecommons.org/licenses/by-sa/2.5/legalcode", + osiApproved: false, + }, + "OLDAP-2.7": { + name: "Open LDAP Public License v2.7", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=47c2415c1df81556eeb39be6cad458ef87c534a2", + osiApproved: false, + }, + "UCL-1.0": { + name: "Upstream Compatibility License v1.0", + url: "https://opensource.org/licenses/UCL-1.0", + osiApproved: true, + }, + MTLL: { + name: "Matrix Template Library License", + url: "https://fedoraproject.org/wiki/Licensing/Matrix_Template_Library_License", + osiApproved: false, + }, + "HPND-export2-US": { + name: "HPND with US Government export control and 2 disclaimers", + url: "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L111-L133", + osiApproved: false, + }, + "OFL-1.0-RFN": { + name: "SIL Open Font License 1.0 with Reserved Font Name", + url: "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL10_web", + osiApproved: false, + }, + "ZPL-2.0": { + name: "Zope Public License 2.0", + url: "http://old.zope.org/Resources/License/ZPL-2.0", + osiApproved: true, + }, + "bcrypt-Solar-Designer": { + name: "bcrypt Solar Designer License", + url: "https://github.com/bcrypt-ruby/bcrypt-ruby/blob/master/ext/mri/crypt_blowfish.c", + osiApproved: false, + }, + "CC-BY-NC-SA-3.0-DE": { + name: "Creative Commons Attribution Non Commercial Share Alike 3.0 Germany", + url: "https://creativecommons.org/licenses/by-nc-sa/3.0/de/legalcode", + osiApproved: false, + }, + "GFDL-1.1-no-invariants-or-later": { + name: "GNU Free Documentation License v1.1 or later - no invariants", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", + osiApproved: false, + }, + "CC-BY-SA-3.0-IGO": { + name: "Creative Commons Attribution-ShareAlike 3.0 IGO", + url: "https://creativecommons.org/licenses/by-sa/3.0/igo/legalcode", + osiApproved: false, + }, + "Apache-1.1": { + name: "Apache License 1.1", + url: "http://apache.org/licenses/LICENSE-1.1", + osiApproved: true, + }, + "GPL-2.0-with-autoconf-exception": { + name: "GNU General Public License v2.0 w/Autoconf exception", + url: "http://ac-archive.sourceforge.net/doc/copyright.html", + osiApproved: false, + }, + "Caldera-no-preamble": { + name: "Caldera License (without preamble)", + url: "https://github.com/apache/apr/blob/trunk/LICENSE#L298C6-L298C29", + osiApproved: false, + }, + "SSPL-1.0": { + name: "Server Side Public License, v 1", + url: "https://www.mongodb.com/licensing/server-side-public-license", + osiApproved: false, + }, + "DRL-1.1": { + name: "Detection Rule License 1.1", + url: "https://github.com/SigmaHQ/Detection-Rule-License/blob/6ec7fbde6101d101b5b5d1fcb8f9b69fbc76c04a/LICENSE.Detection.Rules.md", + osiApproved: false, + }, + "Linux-man-pages-copyleft-2-para": { + name: "Linux man-pages Copyleft - 2 paragraphs", + url: "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/move_pages.2#n5", + osiApproved: false, + }, + "OLDAP-2.0.1": { + name: "Open LDAP Public License v2.0.1", + url: "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=b6d68acd14e51ca3aab4428bf26522aa74873f0e", + osiApproved: false, + }, + "ANTLR-PD-fallback": { + name: "ANTLR Software Rights Notice with license fallback", + url: "http://www.antlr2.org/license.html", + osiApproved: false, + }, + "CDLA-Permissive-2.0": { + name: "Community Data License Agreement Permissive 2.0", + url: "https://cdla.dev/permissive-2-0", + osiApproved: false, + }, + HIDAPI: { + name: "HIDAPI License", + url: "https://github.com/signal11/hidapi/blob/master/LICENSE-orig.txt", + osiApproved: false, + }, + "bzip2-1.0.6": { + name: "bzip2 and libbzip2 License v1.0.6", + url: "https://sourceware.org/git/?p=bzip2.git;a=blob;f=LICENSE;hb=bzip2-1.0.6", + osiApproved: false, + }, + GL2PS: { + name: "GL2PS License", + url: "http://www.geuz.org/gl2ps/COPYING.GL2PS", + osiApproved: false, + }, + TOSL: { + name: "Trusster Open Source License", + url: "https://fedoraproject.org/wiki/Licensing/TOSL", + osiApproved: false, + }, + Abstyles: { + name: "Abstyles License", + url: "https://fedoraproject.org/wiki/Licensing/Abstyles", + osiApproved: false, + }, + TermReadKey: { + name: "TermReadKey License", + url: "https://github.com/jonathanstowe/TermReadKey/blob/master/README#L9-L10", + osiApproved: false, + }, + "GFDL-1.2": { + name: "GNU Free Documentation License v1.2", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", + osiApproved: false, + }, + xzoom: { + name: "xzoom License", + url: "https://metadata.ftp-master.debian.org/changelogs//main/x/xzoom/xzoom_0.3-27_copyright", + osiApproved: false, + }, + PostgreSQL: { + name: "PostgreSQL License", + url: "http://www.postgresql.org/about/licence", + osiApproved: true, + }, + "CNRI-Python-GPL-Compatible": { + name: "CNRI Python Open Source GPL Compatible License Agreement", + url: "http://www.python.org/download/releases/1.6.1/download_win/", + osiApproved: false, + }, + "Widget-Workshop": { + name: "Widget Workshop License", + url: "https://github.com/novnc/noVNC/blob/master/core/crypto/des.js#L24", + osiApproved: false, + }, + Libpng: { + name: "libpng License", + url: "http://www.libpng.org/pub/png/src/libpng-LICENSE.txt", + osiApproved: false, + }, + "HPND-sell-MIT-disclaimer-xserver": { + name: "Historical Permission Notice and Disclaimer - sell xserver variant with MIT disclaimer", + url: "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L1781", + osiApproved: false, + }, + "CC-BY-NC-SA-1.0": { + name: "Creative Commons Attribution Non Commercial Share Alike 1.0 Generic", + url: "https://creativecommons.org/licenses/by-nc-sa/1.0/legalcode", + osiApproved: false, + }, + "Python-2.0": { + name: "Python License 2.0", + url: "https://opensource.org/licenses/Python-2.0", + osiApproved: true, + }, + "BSD-Systemics-W3Works": { + name: "Systemics W3Works BSD variant license", + url: "https://metacpan.org/release/DPARIS/Crypt-Blowfish-2.14/source/COPYRIGHT#L7", + osiApproved: false, + }, + "LPPL-1.0": { + name: "LaTeX Project Public License v1.0", + url: "http://www.latex-project.org/lppl/lppl-1-0.txt", + osiApproved: false, + }, + "YPL-1.1": { + name: "Yahoo! Public License v1.1", + url: "http://www.zimbra.com/license/yahoo_public_license_1.1.html", + osiApproved: false, + }, + SWL: { + name: "Scheme Widget Library (SWL) Software License Agreement", + url: "https://fedoraproject.org/wiki/Licensing/SWL", + osiApproved: false, + }, + Giftware: { + name: "Giftware License", + url: "http://liballeg.org/license.html#allegro-4-the-giftware-license", + osiApproved: false, + }, + "CECILL-B": { + name: "CeCILL-B Free Software License Agreement", + url: "http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html", + osiApproved: false, + }, + "OSET-PL-2.1": { + name: "OSET Public License version 2.1", + url: "http://www.osetfoundation.org/public-license", + osiApproved: true, + }, + "GPL-3.0-with-autoconf-exception": { + name: "GNU General Public License v3.0 w/Autoconf exception", + url: "https://www.gnu.org/licenses/autoconf-exception-3.0.html", + osiApproved: false, + }, + "CAL-1.0-Combined-Work-Exception": { + name: "Cryptographic Autonomy License 1.0 (Combined Work Exception)", + url: "http://cryptographicautonomylicense.com/license-text.html", + osiApproved: true, + }, + "HPND-sell-variant-MIT-disclaimer-rev": { + name: "HPND sell variant with MIT disclaimer - reverse", + url: "https://github.com/sigmavirus24/x11-ssh-askpass/blob/master/dynlist.c", + osiApproved: false, + }, + JSON: { + name: "JSON License", + url: "http://www.json.org/license.html", + osiApproved: false, + }, + "GFDL-1.2-only": { + name: "GNU Free Documentation License v1.2 only", + url: "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", + osiApproved: false, + }, + pkgconf: { + name: "pkgconf License", + url: "https://github.com/pkgconf/pkgconf/blob/master/cli/main.c#L8", + osiApproved: false, + }, + "Unicode-DFS-2016": { + name: "Unicode License Agreement - Data Files and Software (2016)", + url: "https://www.unicode.org/license.txt", + osiApproved: true, + }, + "PHP-3.01": { + name: "PHP License v3.01", + url: "http://www.php.net/license/3_01.txt", + osiApproved: true, + }, + blessing: { + name: "SQLite Blessing", + url: "https://www.sqlite.org/src/artifact/e33a4df7e32d742a?ln=4-9", + osiApproved: false, + }, + "RPSL-1.0": { + name: "RealNetworks Public Source License v1.0", + url: "https://helixcommunity.org/content/rpsl", + osiApproved: true, + }, + "BitTorrent-1.0": { + name: "BitTorrent Open Source License v1.0", + url: "http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/licenses/BitTorrent?r1=1.1&r2=1.1.1.1&diff_format=s", + osiApproved: false, + }, + "SISSL-1.2": { + name: "Sun Industry Standards Source License v1.2", + url: "http://gridscheduler.sourceforge.net/Gridengine_SISSL_license.html", + osiApproved: false, + }, + "GPL-3.0": { + name: "GNU General Public License v3.0 only", + url: "https://www.gnu.org/licenses/gpl-3.0-standalone.html", + osiApproved: true, + }, + IJG: { + name: "Independent JPEG Group License", + url: "http://dev.w3.org/cvsweb/Amaya/libjpeg/Attic/README?rev=1.2", + osiApproved: false, + }, + "OGL-Canada-2.0": { + name: "Open Government Licence - Canada", + url: "https://open.canada.ca/en/open-government-licence-canada", + osiApproved: false, + }, + "CC-BY-ND-2.5": { + name: "Creative Commons Attribution No Derivatives 2.5 Generic", + url: "https://creativecommons.org/licenses/by-nd/2.5/legalcode", + osiApproved: false, + }, + "HPND-Pbmplus": { + name: "Historical Permission Notice and Disclaimer - Pbmplus variant", + url: "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/netpbm.c#l8", + osiApproved: false, + }, + "CC-BY-NC-ND-3.0-DE": { + name: "Creative Commons Attribution Non Commercial No Derivatives 3.0 Germany", + url: "https://creativecommons.org/licenses/by-nc-nd/3.0/de/legalcode", + osiApproved: false, + }, + "RPL-1.5": { + name: "Reciprocal Public License 1.5", + url: "https://opensource.org/licenses/RPL-1.5", + osiApproved: true, + }, + Nokia: { + name: "Nokia Open Source License", + url: "https://opensource.org/licenses/nokia", + osiApproved: true, + }, + "HPND-doc-sell": { + name: "Historical Permission Notice and Disclaimer - documentation sell variant", + url: "https://gitlab.freedesktop.org/xorg/lib/libxtst/-/blob/master/COPYING?ref_type=heads#L108-117", + osiApproved: false, + }, } as const; diff --git a/build.ts b/build.ts index 964fb30..892bf39 100755 --- a/build.ts +++ b/build.ts @@ -46,6 +46,7 @@ const schemasToGenerate = { "Schema", "Response", "Parameter", + "PathItem", "Example", "RequestBody", "Header", @@ -80,9 +81,7 @@ const schemasToGenerate = { ], }; -async function generateAllSchemasForVersion( - version: string -): Promise { +async function generateAllSchemasForVersion(version: string): Promise { const results: BuildResult[] = []; const outputDir = resolve(`./schemas/${version}`); @@ -113,9 +112,7 @@ async function generateAllSchemasForVersion( // Generate schema for ALL exported types at once try { - console.log( - `🔍 Generating schemas for all exported types in ${version}...` - ); + console.log(`🔍 Generating schemas for all exported types in ${version}...`); const schema = generator.createSchema(); // No type parameter = all types if (schema?.definitions) { @@ -123,9 +120,7 @@ async function generateAllSchemasForVersion( const definitionNames = Object.keys(definitions); console.log( - `📋 Found ${ - definitionNames.length - } exported types: ${definitionNames.join(", ")}` + `📋 Found ${definitionNames.length} exported types: ${definitionNames.join(", ")}` ); // Generate main specification schema (if it exists) @@ -150,11 +145,7 @@ async function generateAllSchemasForVersion( // Generate individual component schemas for (const [typeName, typeSchema] of Object.entries(definitions)) { if (typeName === "Specification") continue; // Skip main spec, already handled - if ( - !schemasToGenerate[ - version as keyof typeof schemasToGenerate - ].includes(typeName) - ) + if (!schemasToGenerate[version as keyof typeof schemasToGenerate].includes(typeName)) continue; // Skip types that are not in the schemasToGenerate object try { @@ -173,9 +164,7 @@ async function generateAllSchemasForVersion( success: true, outputPath, }); - console.log( - `✅ Generated component schema for ${version}/${typeName}` - ); + console.log(`✅ Generated component schema for ${version}/${typeName}`); } catch (error) { results.push({ version, @@ -183,10 +172,7 @@ async function generateAllSchemasForVersion( success: false, error: error instanceof Error ? error.message : String(error), }); - console.error( - `❌ Failed to generate schema for ${version}/${typeName}:`, - error - ); + console.error(`❌ Failed to generate schema for ${version}/${typeName}:`, error); } } } else { @@ -255,8 +241,8 @@ async function generateIndexFiles(): Promise { if (existsSync(componentsDir)) { componentFiles = readdirSync(componentsDir) - .filter((file) => file.endsWith(".json")) - .map((file) => file.replace(".json", "")); + .filter(file => file.endsWith(".json")) + .map(file => file.replace(".json", "")); for (const component of componentFiles) { indexContent += `export { default as ${component} } from "./components/${component}.json";\n`; @@ -338,8 +324,8 @@ async function main() { await generateIndexFiles(); // Summary - const successful = allResults.filter((r) => r.success); - const failed = allResults.filter((r) => !r.success); + const successful = allResults.filter(r => r.success); + const failed = allResults.filter(r => !r.success); console.log("📊 Build Summary:"); console.log(`✅ Successful: ${successful.length}`); @@ -347,7 +333,7 @@ async function main() { if (failed.length > 0) { console.log("\n❌ Failed generations:"); - failed.forEach((result) => { + failed.forEach(result => { console.log(` - ${result.version}/${result.type}: ${result.error}`); }); } diff --git a/bun.lock b/bun.lock index b982a85..0e31fa7 100644 --- a/bun.lock +++ b/bun.lock @@ -3,12 +3,11 @@ "workspaces": { "": { "name": "openapi-types", - "dependencies": { - "ajv": "^8.17.1", - }, "devDependencies": { "@biomejs/biome": "^2.2.4", "@types/bun": "^1.2.23", + "ajv": "^8.17.1", + "prettier": "^3.6.2", "rimraf": "^6.0.1", "ts-json-schema-generator": "^2.4.0", "tsd": "^0.33.0", @@ -250,6 +249,8 @@ "plur": ["plur@4.0.0", "", { "dependencies": { "irregular-plurals": "^3.2.0" } }, "sha512-4UGewrYgqDFw9vV6zNV+ADmPAUAfJPKtGvb/VdpQAx25X5f3xXdGdyOEVFwkl8Hl/tl7+xbeHqSEM+D5/TirUg=="], + "prettier": ["prettier@3.6.2", "", { "bin": { "prettier": "bin/prettier.cjs" } }, "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ=="], + "pretty-format": ["pretty-format@29.7.0", "", { "dependencies": { "@jest/schemas": "^29.6.3", "ansi-styles": "^5.0.0", "react-is": "^18.0.0" } }, "sha512-Pdlw/oPxN+aXdmM9R00JVC9WVFoCLTKJvDVLgmJ+qAffBMxsV85l/Lu7sNx4zSzPyoL2euImuEwHhOXdEgNFZQ=="], "queue-microtask": ["queue-microtask@1.2.3", "", {}, "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A=="], diff --git a/package.json b/package.json index 5f8ef54..9a69e19 100644 --- a/package.json +++ b/package.json @@ -35,6 +35,8 @@ "dev": "bun run --watch index.ts", "lint": "biome check .", "lint:fix": "biome check --write .", + "format": "prettier --check .", + "format:fix": "prettier --write .", "test:version": "node scripts/test-version-comparison.js", "schemas:clean": "rm -rf schemas/", "schemas:validate": "echo 'Schema validation not yet implemented'" @@ -44,6 +46,7 @@ "@biomejs/biome": "^2.2.4", "@types/bun": "^1.2.23", "ajv": "^8.17.1", + "prettier": "^3.6.2", "rimraf": "^6.0.1", "ts-json-schema-generator": "^2.4.0", "tsd": "^0.33.0", diff --git a/schemas/2.0/components/parameter.json b/schemas/2.0/components/parameter.json index 1cc2d3a..46e182c 100644 --- a/schemas/2.0/components/parameter.json +++ b/schemas/2.0/components/parameter.json @@ -27,42 +27,23 @@ "type": "string", "description": "The host (name or IP) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.", "markdownDescription": "The host (name or IP) serving the API. This MUST be the host only and does\nnot include the scheme nor sub-paths. It MAY include a port. If the host\nis not included, the host serving the documentation is to be used\n(including the port). The host does not support path templating.", - "examples": [ - "api.example.com", - "api.example.com:8080" - ] + "examples": ["api.example.com", "api.example.com:8080"] }, "basePath": { "type": "string", "description": "The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating.", "markdownDescription": "The base path on which the API is served, which is relative to the host.\nIf it is not included, the API is served directly under the host.\nThe value MUST start with a leading slash (/). The basePath does not\nsupport path templating.", - "examples": [ - "/v1", - "/api/v2" - ] + "examples": ["/v1", "/api/v2"] }, "schemes": { "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol of the API. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default scheme to be used is the one used to access the specification.", "markdownDescription": "The transfer protocol of the API. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default\nscheme to be used is the one used to access the specification.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "consumes": { "type": "array", @@ -71,15 +52,7 @@ }, "description": "A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can consume. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -88,15 +61,7 @@ }, "description": "A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can produce. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "paths": { "$ref": "#/definitions/Paths", @@ -163,10 +128,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -199,11 +161,7 @@ ] } }, - "required": [ - "info", - "paths", - "swagger" - ], + "required": ["info", "paths", "swagger"], "description": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.", "markdownDescription": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more." }, @@ -214,10 +172,7 @@ "type": "string", "description": "The title of the application. This field is required.", "markdownDescription": "The title of the application. This field is required.", - "examples": [ - "Swagger Sample App", - "My API" - ] + "examples": ["Swagger Sample App", "My API"] }, "description": { "type": "string", @@ -232,10 +187,7 @@ "type": "string", "description": "The Terms of Service for the API.", "markdownDescription": "The Terms of Service for the API.", - "examples": [ - "http://swagger.io/terms/", - "https://example.com/terms" - ] + "examples": ["http://swagger.io/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -263,16 +215,10 @@ "type": "string", "description": "Provides the version of the application API (not to be confused with the specification version). This field is required.", "markdownDescription": "Provides the version of the application API (not to be confused with the specification version).\nThis field is required.", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.", "markdownDescription": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients\nif needed, and can be presented in the Swagger-UI for convenience." }, @@ -283,28 +229,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.swagger.io/support", - "https://example.com/contact" - ] + "examples": ["http://www.swagger.io/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@swagger.io", - "contact@example.com" - ] + "examples": ["support@swagger.io", "contact@example.com"] } }, "description": "Contact Object\n\nContact information for the exposed API.", @@ -317,11 +254,7 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "MIT License", - "Apache License 2.0", - "Proprietary Foo License" - ] + "examples": ["MIT License", "Apache License 2.0", "Proprietary Foo License"] }, "url": { "type": "string", @@ -334,9 +267,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n-----\nFields\n-----" }, @@ -501,24 +432,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in swagger-ui, this field SHOULD be less than 120 characters.", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nswagger-ui, this field SHOULD be less than 120 characters.", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -543,10 +463,7 @@ "type": "string", "description": "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.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "consumes": { "type": "array", @@ -555,15 +472,7 @@ }, "description": "A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can consume. This overrides the consumes\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -572,15 +481,7 @@ }, "description": "A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can produce. This overrides the produces\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "parameters": { "type": "array", @@ -626,32 +527,17 @@ "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol for the operation. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object schemes definition.", "markdownDescription": "The transfer protocol for the operation. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object\nschemes definition.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "deprecated": { "type": "boolean", "description": "Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Usage of the declared operation\nshould be refrained. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -675,18 +561,13 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined by a combination of a path and an HTTP method.", "markdownDescription": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined\nby a combination of a path and an HTTP method." }, @@ -716,9 +597,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation. This object provides a way to link to additional documentation that supplements the API specification, such as detailed guides, tutorials, or reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\nThis object provides a way to link to additional documentation that\nsupplements the API specification, such as detailed guides, tutorials,\nor reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n-----\nFields\n-----" }, @@ -739,37 +618,26 @@ "type": "string", "description": "The name of the parameter. For body parameters, this is used for documentation purposes only and has no effect on the parameter itself.", "markdownDescription": "The name of the parameter. For body parameters, this is used for documentation\npurposes only and has no effect on the parameter itself.", - "examples": [ - "user", - "data", - "payload" - ] + "examples": ["user", "data", "payload"] }, "in": { "type": "string", "const": "body", "description": "The location of the parameter. Must be \"body\" for body parameters.", "markdownDescription": "The location of the parameter. Must be \"body\" for body parameters.", - "examples": [ - "body" - ] + "examples": ["body"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "User object to create", - "Request payload containing the data to process" - ] + "examples": ["User object to create", "Request payload containing the data to process"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. Default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "schema": { @@ -791,11 +659,7 @@ ] } }, - "required": [ - "name", - "in", - "schema" - ], + "required": ["name", "in", "schema"], "description": "----- Parameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent the payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload, which can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent\nthe payload that's appended to the HTTP request. Since there can only be one\npayload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload,\nwhich can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -837,20 +701,13 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate that this schema represents string data.", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate\nthat this schema represents string data.", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -865,11 +722,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -881,10 +734,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -893,23 +743,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -922,38 +758,26 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "maxLength": { "type": "number", "description": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", "markdownDescription": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", "markdownDescription": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "A string is valid against \"pattern\" if the regular expression matches the string successfully. The regular expression syntax follows ECMA 262.", "markdownDescription": "A string is valid against \"pattern\" if the regular expression matches the string successfully.\nThe regular expression syntax follows ECMA 262.", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -967,9 +791,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation rules. They are one of the most commonly used schema types in API specifications, used for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like email, date, and UUID, as well as custom formats defined by the API provider. They also support comprehensive validation through pattern matching, length constraints, and enumeration.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation\nrules. They are one of the most commonly used schema types in API specifications,\nused for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like\nemail, date, and UUID, as well as custom formats defined by the API provider.\nThey also support comprehensive validation through pattern matching, length\nconstraints, and enumeration.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -980,11 +802,7 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object, it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside\nthe items), it will affect the wrapping element and only if wrapped is true.", - "examples": [ - "animal", - "item", - "person" - ] + "examples": ["animal", "item", "person"] }, "namespace": { "type": "string", @@ -1000,30 +818,20 @@ "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "sample", - "xs", - "ex" - ] + "examples": ["sample", "xs", "ex"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ) or unwrapped ().\nDefault value is false. The definition takes effect only when defined alongside\ntype being array (outside the items).", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false } }, @@ -1038,20 +846,13 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate that this schema represents numeric data (both integers and floating-point).", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate\nthat this schema represents numeric data (both integers and floating-point).", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1066,11 +867,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1082,10 +879,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1094,23 +888,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1123,56 +903,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 0.01 - ] + "examples": [2, 0.01] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1186,9 +948,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point numbers. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and other numeric data in APIs. They support range validation, precision control, and multiple format specifications.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point\nnumbers. They support various formats and validation rules to ensure data\nintegrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and\nother numeric data in APIs. They support range validation, precision control,\nand multiple format specifications.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1200,18 +960,13 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate that this schema represents whole number data without fractional components.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate\nthat this schema represents whole number data without fractional components.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "description": { "type": "string", @@ -1226,11 +981,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1242,10 +993,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1254,23 +1002,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1283,56 +1017,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 1 - ] + "examples": [2, 1] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1346,9 +1062,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other discrete numeric values in APIs. They support range validation and multiple format specifications including int32 and int64.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components.\nThey support various formats and validation rules to ensure data integrity\nand provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other\ndiscrete numeric values in APIs. They support range validation and multiple\nformat specifications including int32 and int64.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1360,20 +1074,13 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate that this schema represents true/false values.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate\nthat this schema represents true/false values.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1388,11 +1095,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1404,10 +1107,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1416,23 +1116,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1445,10 +1131,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1463,9 +1146,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches, and other binary state indicators in APIs. They are simple but essential data types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators, configuration options, and other binary state representations. They support default values and examples to help API consumers understand the expected behavior.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches,\nand other binary state indicators in APIs. They are simple but essential\ndata types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators,\nconfiguration options, and other binary state representations. They support\ndefault values and examples to help API consumers understand the expected\nbehavior.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1477,20 +1158,13 @@ "const": "file", "description": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate that this schema represents file data. This is a Swagger 2.0 specific type that extends JSON Schema.", "markdownDescription": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate\nthat this schema represents file data. This is a Swagger 2.0 specific\ntype that extends JSON Schema.", - "examples": [ - "file" - ] + "examples": ["file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1505,11 +1179,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1521,10 +1191,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1533,23 +1200,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1562,10 +1215,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1580,9 +1230,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- File Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0 specific data type that extends the JSON Schema specification to support file operations. File schemas are used by Parameter and Response objects to indicate that the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing, image handling, and other file-based operations. They provide clear indication to API consumers that file data is expected or returned.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } | | 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nFile Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0\nspecific data type that extends the JSON Schema specification to support file\noperations. File schemas are used by Parameter and Response objects to indicate\nthat the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing,\nimage handling, and other file-based operations. They provide clear indication\nto API consumers that file data is expected or returned.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n| 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n-----\nFields\n-----" }, @@ -1594,9 +1242,7 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate that this schema represents an ordered collection of items.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate\nthat this schema represents an ordered collection of items.", - "examples": [ - "array" - ] + "examples": ["array"] }, "items": { "$ref": "#/definitions/Schema", @@ -1623,28 +1269,19 @@ "type": "number", "description": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", "markdownDescription": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", "markdownDescription": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "uniqueItems": { "type": "boolean", "description": "An array is valid against \"uniqueItems\" if all its elements are unique.", "markdownDescription": "An array is valid against \"uniqueItems\" if all its elements are unique.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1658,10 +1295,7 @@ ] } }, - "required": [ - "type", - "items" - ], + "required": ["type", "items"], "description": "----- Array Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms to a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific adjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs. They support validation of array length, item uniqueness, and item type constraints. The items property defines the schema that each array element must conform to.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms\nto a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific\nadjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs.\nThey support validation of array length, item uniqueness, and item type constraints.\nThe items property defines the schema that each array element must conform to.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1673,9 +1307,7 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate that this schema represents structured data with named properties.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate\nthat this schema represents structured data with named properties.", - "examples": [ - "object" - ] + "examples": ["object"] }, "properties": { "type": "object", @@ -1708,15 +1340,8 @@ "description": "A list of required properties. Properties marked as required being true MUST be present in the object.\n\nThis array contains the names of properties that must be present in any valid instance of this object schema. Properties not listed here are considered optional.", "markdownDescription": "A list of required properties. Properties marked as required being true\nMUST be present in the object.\n\nThis array contains the names of properties that must be present in\nany valid instance of this object schema. Properties not listed here\nare considered optional.", "examples": [ - [ - "name", - "email" - ], - [ - "id", - "type", - "createdAt" - ] + ["name", "email"], + ["id", "type", "createdAt"] ] }, "additionalProperties": { @@ -1763,19 +1388,13 @@ "type": "number", "description": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", "markdownDescription": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", "markdownDescription": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1809,9 +1428,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- JSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse. The Reference Object is a JSON Reference that uses a JSON Pointer as its value. For this specification, only canonical dereferencing is supported.\n\nJSON References enable reusability and modularity in API specifications by allowing the same definition to be referenced multiple times throughout the document. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } | | 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } | | 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n----- Fields\n-----", "markdownDescription": "-----\nJSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification.\nIt can be used to reference parameters and responses that are defined at the\ntop level for reuse. The Reference Object is a JSON Reference that uses a\nJSON Pointer as its value. For this specification, only canonical dereferencing\nis supported.\n\nJSON References enable reusability and modularity in API specifications by\nallowing the same definition to be referenced multiple times throughout the\ndocument. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } |\n| 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } |\n| 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n-----\nFields\n-----" @@ -1823,83 +1440,46 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "formData" - ], + "enum": ["query", "header", "path", "formData"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", - "examples": [ - "query", - "path", - "header", - "formData" - ] + "examples": ["query", "path", "header", "formData"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "The user ID", - "Maximum number of items to return (default: 10)" - ] + "examples": ["The user ID", "Maximum number of items to return (default: 10)"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. If the parameter is in \"path\", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter is in \"path\",\nthis property is required and its value MUST be true. Otherwise, the property\nMAY be included and its default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "type": { "type": "string", - "enum": [ - "string", - "number", - "integer", - "boolean", - "array", - "file" - ], + "enum": ["string", "number", "integer", "boolean", "array", "file"], "description": "The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\", the consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\" or both and the parameter MUST be in \"formData\".", "markdownDescription": "The type of the parameter. Since the parameter is not located at the request body,\nit is limited to simple types (that is, not an object). The value MUST be one of\n\"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\",\nthe consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\"\nor both and the parameter MUST be in \"formData\".", - "examples": [ - "string", - "integer", - "array", - "file" - ] + "examples": ["string", "integer", "array", "file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for either\nquery or formData parameters and allows you to send a parameter with a name only\nor an empty value. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -1918,135 +1498,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes", - "multi" - ], + "enum": ["csv", "ssv", "tsv", "pipes", "multi"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the parameter that the server will use if none is provided. This value MUST conform to the defined type for this parameter.", "markdownDescription": "Declares the value of the parameter that the server will use if none is provided.\nThis value MUST conform to the defined type for this parameter.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "name", - "in", - "type" - ], + "required": ["name", "in", "type"], "description": "----- Parameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include query, header, path, and formData parameters. They have different validation rules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file) and include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include\nquery, header, path, and formData parameters. They have different validation\nrules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file)\nand include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -2057,21 +1594,13 @@ "type": "string", "description": "The internal type of the array. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". Files and models are not allowed.", "markdownDescription": "The internal type of the array. The value MUST be one of \"string\", \"number\",\n\"integer\", \"boolean\", or \"array\". Files and models are not allowed.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2089,132 +1618,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the item that the server will use if none is provided. This value MUST conform to the defined type for the data type.", "markdownDescription": "Declares the value of the item that the server will use if none is provided.\nThis value MUST conform to the defined type for the data type.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in \"body\".", "markdownDescription": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions\nthat are not located in \"body\"." }, @@ -2613,9 +2102,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes because they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.", "markdownDescription": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected\nresponses of an operation. The container maps a HTTP response code to the expected\nresponse. It is not expected from the documentation to necessarily cover all\npossible HTTP response codes because they may not be known in advance. However,\nit is expected from the documentation to cover a successful operation response\nand any known errors." }, @@ -2626,30 +2113,19 @@ "type": "string", "description": "A brief description of the header. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the header. GFM syntax can be used for rich text representation.", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "type": { "type": "string", "description": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". This field is required.", "markdownDescription": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\",\n\"boolean\", or \"array\".\nThis field is required.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2667,132 +2143,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the header that the server will use if none is provided. This value MUST conform to the defined type for the header.", "markdownDescription": "Declares the value of the header that the server will use if none is provided.\nThis value MUST conform to the defined type for the header.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with the response. The name is used to refer to the respective header definition. The value of the header is of type string.", "markdownDescription": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with\nthe response. The name is used to refer to the respective header definition.\nThe value of the header is of type string." }, @@ -2876,65 +2312,36 @@ "properties": { "type": { "type": "string", - "enum": [ - "basic", - "apiKey", - "oauth2" - ], + "enum": ["basic", "apiKey", "oauth2"], "description": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\". This field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", "markdownDescription": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\".\nThis field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", - "examples": [ - "apiKey", - "oauth2", - "basic" - ] + "examples": ["apiKey", "oauth2", "basic"] }, "description": { "type": "string", "description": "A short description for security scheme. GFM syntax can be used for rich text representation.", "markdownDescription": "A short description for security scheme. GFM syntax can be used for rich text representation.", - "examples": [ - "API key for authentication", - "OAuth 2.0 with authorization code flow" - ] + "examples": ["API key for authentication", "OAuth 2.0 with authorization code flow"] }, "name": { "type": "string", "description": "The name of the header or query parameter to be used. This field is required for apiKey type and applies to apiKey type only.", "markdownDescription": "The name of the header or query parameter to be used. This field is required\nfor apiKey type and applies to apiKey type only.", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header" - ], + "enum": ["query", "header"], "description": "The location of the API key. This field is required for apiKey type and applies to apiKey type only. Valid values are \"query\" or \"header\".", "markdownDescription": "The location of the API key. This field is required for apiKey type and\napplies to apiKey type only. Valid values are \"query\" or \"header\".", - "examples": [ - "header", - "query" - ] + "examples": ["header", "query"] }, "flow": { "type": "string", - "enum": [ - "implicit", - "password", - "application", - "accessCode" - ], + "enum": ["implicit", "password", "application", "accessCode"], "description": "The flow used by the OAuth2 security scheme. This field is required for oauth2 type and applies to oauth2 type only. Valid values are \"implicit\", \"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", "markdownDescription": "The flow used by the OAuth2 security scheme. This field is required for\noauth2 type and applies to oauth2 type only. Valid values are \"implicit\",\n\"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", - "examples": [ - "accessCode", - "implicit", - "password" - ] + "examples": ["accessCode", "implicit", "password"] }, "authorizationUrl": { "type": "string", @@ -2949,10 +2356,7 @@ "type": "string", "description": "The token URL to be used for this flow. This SHOULD be in the form of a URL. This field is required for oauth2 type and applies to oauth2 type only.", "markdownDescription": "The token URL to be used for this flow. This SHOULD be in the form of a URL.\nThis field is required for oauth2 type and applies to oauth2 type only.", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "scopes": { "$ref": "#/definitions/Scopes", @@ -2969,9 +2373,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).", "markdownDescription": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare basic authentication, an API key (either as a header or as a query parameter)\nand OAuth2's common flows (implicit, password, application and access code)." }, @@ -3008,10 +2410,7 @@ "api_key": [] }, { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] }, @@ -3025,12 +2424,7 @@ "type": "string", "description": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and must be unique within the entire specification. It should be descriptive and follow a consistent naming convention.", "markdownDescription": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and\nmust be unique within the entire specification. It should be descriptive\nand follow a consistent naming convention.", - "examples": [ - "users", - "pets", - "authentication", - "reports" - ] + "examples": ["users", "pets", "authentication", "reports"] }, "description": { "type": "string", @@ -3058,11 +2452,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations by resources or any other qualifier. 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.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations\nby resources or any other qualifier. The order of the tags can be used to reflect\non their order by the parsing tools. Not all tags that are used by the Operation\nObject must be declared. The tags that are not declared may be organized randomly\nor based on the tools' logic. Each tag name in the list MUST be unique.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/2.0/components/pathitem.json b/schemas/2.0/components/pathitem.json index 779e605..7fa2ff3 100644 --- a/schemas/2.0/components/pathitem.json +++ b/schemas/2.0/components/pathitem.json @@ -160,42 +160,23 @@ "type": "string", "description": "The host (name or IP) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.", "markdownDescription": "The host (name or IP) serving the API. This MUST be the host only and does\nnot include the scheme nor sub-paths. It MAY include a port. If the host\nis not included, the host serving the documentation is to be used\n(including the port). The host does not support path templating.", - "examples": [ - "api.example.com", - "api.example.com:8080" - ] + "examples": ["api.example.com", "api.example.com:8080"] }, "basePath": { "type": "string", "description": "The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating.", "markdownDescription": "The base path on which the API is served, which is relative to the host.\nIf it is not included, the API is served directly under the host.\nThe value MUST start with a leading slash (/). The basePath does not\nsupport path templating.", - "examples": [ - "/v1", - "/api/v2" - ] + "examples": ["/v1", "/api/v2"] }, "schemes": { "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol of the API. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default scheme to be used is the one used to access the specification.", "markdownDescription": "The transfer protocol of the API. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default\nscheme to be used is the one used to access the specification.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "consumes": { "type": "array", @@ -204,15 +185,7 @@ }, "description": "A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can consume. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -221,15 +194,7 @@ }, "description": "A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can produce. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "paths": { "$ref": "#/definitions/Paths", @@ -296,10 +261,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -332,11 +294,7 @@ ] } }, - "required": [ - "info", - "paths", - "swagger" - ], + "required": ["info", "paths", "swagger"], "description": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.", "markdownDescription": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more." }, @@ -347,10 +305,7 @@ "type": "string", "description": "The title of the application. This field is required.", "markdownDescription": "The title of the application. This field is required.", - "examples": [ - "Swagger Sample App", - "My API" - ] + "examples": ["Swagger Sample App", "My API"] }, "description": { "type": "string", @@ -365,10 +320,7 @@ "type": "string", "description": "The Terms of Service for the API.", "markdownDescription": "The Terms of Service for the API.", - "examples": [ - "http://swagger.io/terms/", - "https://example.com/terms" - ] + "examples": ["http://swagger.io/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -396,16 +348,10 @@ "type": "string", "description": "Provides the version of the application API (not to be confused with the specification version). This field is required.", "markdownDescription": "Provides the version of the application API (not to be confused with the specification version).\nThis field is required.", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.", "markdownDescription": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients\nif needed, and can be presented in the Swagger-UI for convenience." }, @@ -416,28 +362,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.swagger.io/support", - "https://example.com/contact" - ] + "examples": ["http://www.swagger.io/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@swagger.io", - "contact@example.com" - ] + "examples": ["support@swagger.io", "contact@example.com"] } }, "description": "Contact Object\n\nContact information for the exposed API.", @@ -450,11 +387,7 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "MIT License", - "Apache License 2.0", - "Proprietary Foo License" - ] + "examples": ["MIT License", "Apache License 2.0", "Proprietary Foo License"] }, "url": { "type": "string", @@ -467,9 +400,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n-----\nFields\n-----" }, @@ -634,24 +565,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in swagger-ui, this field SHOULD be less than 120 characters.", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nswagger-ui, this field SHOULD be less than 120 characters.", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -676,10 +596,7 @@ "type": "string", "description": "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.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "consumes": { "type": "array", @@ -688,15 +605,7 @@ }, "description": "A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can consume. This overrides the consumes\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -705,15 +614,7 @@ }, "description": "A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can produce. This overrides the produces\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "parameters": { "type": "array", @@ -759,32 +660,17 @@ "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol for the operation. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object schemes definition.", "markdownDescription": "The transfer protocol for the operation. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object\nschemes definition.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "deprecated": { "type": "boolean", "description": "Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Usage of the declared operation\nshould be refrained. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -808,18 +694,13 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined by a combination of a path and an HTTP method.", "markdownDescription": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined\nby a combination of a path and an HTTP method." }, @@ -849,9 +730,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation. This object provides a way to link to additional documentation that supplements the API specification, such as detailed guides, tutorials, or reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\nThis object provides a way to link to additional documentation that\nsupplements the API specification, such as detailed guides, tutorials,\nor reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n-----\nFields\n-----" }, @@ -872,37 +751,26 @@ "type": "string", "description": "The name of the parameter. For body parameters, this is used for documentation purposes only and has no effect on the parameter itself.", "markdownDescription": "The name of the parameter. For body parameters, this is used for documentation\npurposes only and has no effect on the parameter itself.", - "examples": [ - "user", - "data", - "payload" - ] + "examples": ["user", "data", "payload"] }, "in": { "type": "string", "const": "body", "description": "The location of the parameter. Must be \"body\" for body parameters.", "markdownDescription": "The location of the parameter. Must be \"body\" for body parameters.", - "examples": [ - "body" - ] + "examples": ["body"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "User object to create", - "Request payload containing the data to process" - ] + "examples": ["User object to create", "Request payload containing the data to process"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. Default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "schema": { @@ -924,11 +792,7 @@ ] } }, - "required": [ - "name", - "in", - "schema" - ], + "required": ["name", "in", "schema"], "description": "----- Parameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent the payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload, which can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent\nthe payload that's appended to the HTTP request. Since there can only be one\npayload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload,\nwhich can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -970,20 +834,13 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate that this schema represents string data.", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate\nthat this schema represents string data.", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -998,11 +855,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1014,10 +867,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1026,23 +876,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1055,38 +891,26 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "maxLength": { "type": "number", "description": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", "markdownDescription": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", "markdownDescription": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "A string is valid against \"pattern\" if the regular expression matches the string successfully. The regular expression syntax follows ECMA 262.", "markdownDescription": "A string is valid against \"pattern\" if the regular expression matches the string successfully.\nThe regular expression syntax follows ECMA 262.", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1100,9 +924,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation rules. They are one of the most commonly used schema types in API specifications, used for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like email, date, and UUID, as well as custom formats defined by the API provider. They also support comprehensive validation through pattern matching, length constraints, and enumeration.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation\nrules. They are one of the most commonly used schema types in API specifications,\nused for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like\nemail, date, and UUID, as well as custom formats defined by the API provider.\nThey also support comprehensive validation through pattern matching, length\nconstraints, and enumeration.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1113,11 +935,7 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object, it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside\nthe items), it will affect the wrapping element and only if wrapped is true.", - "examples": [ - "animal", - "item", - "person" - ] + "examples": ["animal", "item", "person"] }, "namespace": { "type": "string", @@ -1133,30 +951,20 @@ "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "sample", - "xs", - "ex" - ] + "examples": ["sample", "xs", "ex"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ) or unwrapped ().\nDefault value is false. The definition takes effect only when defined alongside\ntype being array (outside the items).", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false } }, @@ -1171,20 +979,13 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate that this schema represents numeric data (both integers and floating-point).", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate\nthat this schema represents numeric data (both integers and floating-point).", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1199,11 +1000,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1215,10 +1012,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1227,23 +1021,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1256,56 +1036,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 0.01 - ] + "examples": [2, 0.01] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1319,9 +1081,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point numbers. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and other numeric data in APIs. They support range validation, precision control, and multiple format specifications.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point\nnumbers. They support various formats and validation rules to ensure data\nintegrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and\nother numeric data in APIs. They support range validation, precision control,\nand multiple format specifications.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1333,18 +1093,13 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate that this schema represents whole number data without fractional components.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate\nthat this schema represents whole number data without fractional components.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "description": { "type": "string", @@ -1359,11 +1114,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1375,10 +1126,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1387,23 +1135,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1416,56 +1150,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 1 - ] + "examples": [2, 1] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1479,9 +1195,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other discrete numeric values in APIs. They support range validation and multiple format specifications including int32 and int64.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components.\nThey support various formats and validation rules to ensure data integrity\nand provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other\ndiscrete numeric values in APIs. They support range validation and multiple\nformat specifications including int32 and int64.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1493,20 +1207,13 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate that this schema represents true/false values.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate\nthat this schema represents true/false values.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1521,11 +1228,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1537,10 +1240,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1549,23 +1249,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1578,10 +1264,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1596,9 +1279,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches, and other binary state indicators in APIs. They are simple but essential data types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators, configuration options, and other binary state representations. They support default values and examples to help API consumers understand the expected behavior.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches,\nand other binary state indicators in APIs. They are simple but essential\ndata types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators,\nconfiguration options, and other binary state representations. They support\ndefault values and examples to help API consumers understand the expected\nbehavior.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1610,20 +1291,13 @@ "const": "file", "description": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate that this schema represents file data. This is a Swagger 2.0 specific type that extends JSON Schema.", "markdownDescription": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate\nthat this schema represents file data. This is a Swagger 2.0 specific\ntype that extends JSON Schema.", - "examples": [ - "file" - ] + "examples": ["file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1638,11 +1312,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1654,10 +1324,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1666,23 +1333,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1695,10 +1348,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1713,9 +1363,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- File Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0 specific data type that extends the JSON Schema specification to support file operations. File schemas are used by Parameter and Response objects to indicate that the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing, image handling, and other file-based operations. They provide clear indication to API consumers that file data is expected or returned.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } | | 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nFile Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0\nspecific data type that extends the JSON Schema specification to support file\noperations. File schemas are used by Parameter and Response objects to indicate\nthat the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing,\nimage handling, and other file-based operations. They provide clear indication\nto API consumers that file data is expected or returned.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n| 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n-----\nFields\n-----" }, @@ -1727,9 +1375,7 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate that this schema represents an ordered collection of items.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate\nthat this schema represents an ordered collection of items.", - "examples": [ - "array" - ] + "examples": ["array"] }, "items": { "$ref": "#/definitions/Schema", @@ -1756,28 +1402,19 @@ "type": "number", "description": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", "markdownDescription": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", "markdownDescription": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "uniqueItems": { "type": "boolean", "description": "An array is valid against \"uniqueItems\" if all its elements are unique.", "markdownDescription": "An array is valid against \"uniqueItems\" if all its elements are unique.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1791,10 +1428,7 @@ ] } }, - "required": [ - "type", - "items" - ], + "required": ["type", "items"], "description": "----- Array Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms to a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific adjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs. They support validation of array length, item uniqueness, and item type constraints. The items property defines the schema that each array element must conform to.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms\nto a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific\nadjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs.\nThey support validation of array length, item uniqueness, and item type constraints.\nThe items property defines the schema that each array element must conform to.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1806,9 +1440,7 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate that this schema represents structured data with named properties.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate\nthat this schema represents structured data with named properties.", - "examples": [ - "object" - ] + "examples": ["object"] }, "properties": { "type": "object", @@ -1841,15 +1473,8 @@ "description": "A list of required properties. Properties marked as required being true MUST be present in the object.\n\nThis array contains the names of properties that must be present in any valid instance of this object schema. Properties not listed here are considered optional.", "markdownDescription": "A list of required properties. Properties marked as required being true\nMUST be present in the object.\n\nThis array contains the names of properties that must be present in\nany valid instance of this object schema. Properties not listed here\nare considered optional.", "examples": [ - [ - "name", - "email" - ], - [ - "id", - "type", - "createdAt" - ] + ["name", "email"], + ["id", "type", "createdAt"] ] }, "additionalProperties": { @@ -1896,19 +1521,13 @@ "type": "number", "description": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", "markdownDescription": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", "markdownDescription": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1942,9 +1561,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- JSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse. The Reference Object is a JSON Reference that uses a JSON Pointer as its value. For this specification, only canonical dereferencing is supported.\n\nJSON References enable reusability and modularity in API specifications by allowing the same definition to be referenced multiple times throughout the document. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } | | 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } | | 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n----- Fields\n-----", "markdownDescription": "-----\nJSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification.\nIt can be used to reference parameters and responses that are defined at the\ntop level for reuse. The Reference Object is a JSON Reference that uses a\nJSON Pointer as its value. For this specification, only canonical dereferencing\nis supported.\n\nJSON References enable reusability and modularity in API specifications by\nallowing the same definition to be referenced multiple times throughout the\ndocument. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } |\n| 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } |\n| 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n-----\nFields\n-----" @@ -1956,83 +1573,46 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "formData" - ], + "enum": ["query", "header", "path", "formData"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", - "examples": [ - "query", - "path", - "header", - "formData" - ] + "examples": ["query", "path", "header", "formData"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "The user ID", - "Maximum number of items to return (default: 10)" - ] + "examples": ["The user ID", "Maximum number of items to return (default: 10)"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. If the parameter is in \"path\", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter is in \"path\",\nthis property is required and its value MUST be true. Otherwise, the property\nMAY be included and its default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "type": { "type": "string", - "enum": [ - "string", - "number", - "integer", - "boolean", - "array", - "file" - ], + "enum": ["string", "number", "integer", "boolean", "array", "file"], "description": "The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\", the consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\" or both and the parameter MUST be in \"formData\".", "markdownDescription": "The type of the parameter. Since the parameter is not located at the request body,\nit is limited to simple types (that is, not an object). The value MUST be one of\n\"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\",\nthe consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\"\nor both and the parameter MUST be in \"formData\".", - "examples": [ - "string", - "integer", - "array", - "file" - ] + "examples": ["string", "integer", "array", "file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for either\nquery or formData parameters and allows you to send a parameter with a name only\nor an empty value. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -2051,135 +1631,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes", - "multi" - ], + "enum": ["csv", "ssv", "tsv", "pipes", "multi"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the parameter that the server will use if none is provided. This value MUST conform to the defined type for this parameter.", "markdownDescription": "Declares the value of the parameter that the server will use if none is provided.\nThis value MUST conform to the defined type for this parameter.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "name", - "in", - "type" - ], + "required": ["name", "in", "type"], "description": "----- Parameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include query, header, path, and formData parameters. They have different validation rules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file) and include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include\nquery, header, path, and formData parameters. They have different validation\nrules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file)\nand include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -2190,21 +1727,13 @@ "type": "string", "description": "The internal type of the array. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". Files and models are not allowed.", "markdownDescription": "The internal type of the array. The value MUST be one of \"string\", \"number\",\n\"integer\", \"boolean\", or \"array\". Files and models are not allowed.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2222,132 +1751,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the item that the server will use if none is provided. This value MUST conform to the defined type for the data type.", "markdownDescription": "Declares the value of the item that the server will use if none is provided.\nThis value MUST conform to the defined type for the data type.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in \"body\".", "markdownDescription": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions\nthat are not located in \"body\"." }, @@ -2746,9 +2235,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes because they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.", "markdownDescription": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected\nresponses of an operation. The container maps a HTTP response code to the expected\nresponse. It is not expected from the documentation to necessarily cover all\npossible HTTP response codes because they may not be known in advance. However,\nit is expected from the documentation to cover a successful operation response\nand any known errors." }, @@ -2759,30 +2246,19 @@ "type": "string", "description": "A brief description of the header. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the header. GFM syntax can be used for rich text representation.", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "type": { "type": "string", "description": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". This field is required.", "markdownDescription": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\",\n\"boolean\", or \"array\".\nThis field is required.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2800,132 +2276,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the header that the server will use if none is provided. This value MUST conform to the defined type for the header.", "markdownDescription": "Declares the value of the header that the server will use if none is provided.\nThis value MUST conform to the defined type for the header.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with the response. The name is used to refer to the respective header definition. The value of the header is of type string.", "markdownDescription": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with\nthe response. The name is used to refer to the respective header definition.\nThe value of the header is of type string." }, @@ -3009,65 +2445,36 @@ "properties": { "type": { "type": "string", - "enum": [ - "basic", - "apiKey", - "oauth2" - ], + "enum": ["basic", "apiKey", "oauth2"], "description": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\". This field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", "markdownDescription": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\".\nThis field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", - "examples": [ - "apiKey", - "oauth2", - "basic" - ] + "examples": ["apiKey", "oauth2", "basic"] }, "description": { "type": "string", "description": "A short description for security scheme. GFM syntax can be used for rich text representation.", "markdownDescription": "A short description for security scheme. GFM syntax can be used for rich text representation.", - "examples": [ - "API key for authentication", - "OAuth 2.0 with authorization code flow" - ] + "examples": ["API key for authentication", "OAuth 2.0 with authorization code flow"] }, "name": { "type": "string", "description": "The name of the header or query parameter to be used. This field is required for apiKey type and applies to apiKey type only.", "markdownDescription": "The name of the header or query parameter to be used. This field is required\nfor apiKey type and applies to apiKey type only.", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header" - ], + "enum": ["query", "header"], "description": "The location of the API key. This field is required for apiKey type and applies to apiKey type only. Valid values are \"query\" or \"header\".", "markdownDescription": "The location of the API key. This field is required for apiKey type and\napplies to apiKey type only. Valid values are \"query\" or \"header\".", - "examples": [ - "header", - "query" - ] + "examples": ["header", "query"] }, "flow": { "type": "string", - "enum": [ - "implicit", - "password", - "application", - "accessCode" - ], + "enum": ["implicit", "password", "application", "accessCode"], "description": "The flow used by the OAuth2 security scheme. This field is required for oauth2 type and applies to oauth2 type only. Valid values are \"implicit\", \"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", "markdownDescription": "The flow used by the OAuth2 security scheme. This field is required for\noauth2 type and applies to oauth2 type only. Valid values are \"implicit\",\n\"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", - "examples": [ - "accessCode", - "implicit", - "password" - ] + "examples": ["accessCode", "implicit", "password"] }, "authorizationUrl": { "type": "string", @@ -3082,10 +2489,7 @@ "type": "string", "description": "The token URL to be used for this flow. This SHOULD be in the form of a URL. This field is required for oauth2 type and applies to oauth2 type only.", "markdownDescription": "The token URL to be used for this flow. This SHOULD be in the form of a URL.\nThis field is required for oauth2 type and applies to oauth2 type only.", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "scopes": { "$ref": "#/definitions/Scopes", @@ -3102,9 +2506,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).", "markdownDescription": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare basic authentication, an API key (either as a header or as a query parameter)\nand OAuth2's common flows (implicit, password, application and access code)." }, @@ -3141,10 +2543,7 @@ "api_key": [] }, { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] }, @@ -3158,12 +2557,7 @@ "type": "string", "description": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and must be unique within the entire specification. It should be descriptive and follow a consistent naming convention.", "markdownDescription": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and\nmust be unique within the entire specification. It should be descriptive\nand follow a consistent naming convention.", - "examples": [ - "users", - "pets", - "authentication", - "reports" - ] + "examples": ["users", "pets", "authentication", "reports"] }, "description": { "type": "string", @@ -3191,11 +2585,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations by resources or any other qualifier. 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.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations\nby resources or any other qualifier. The order of the tags can be used to reflect\non their order by the parsing tools. Not all tags that are used by the Operation\nObject must be declared. The tags that are not declared may be organized randomly\nor based on the tools' logic. Each tag name in the list MUST be unique.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/2.0/components/response.json b/schemas/2.0/components/response.json index 10d37cd..a571cbe 100644 --- a/schemas/2.0/components/response.json +++ b/schemas/2.0/components/response.json @@ -61,9 +61,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes because they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.", "markdownDescription": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected\nresponses of an operation. The container maps a HTTP response code to the expected\nresponse. It is not expected from the documentation to necessarily cover all\npossible HTTP response codes because they may not be known in advance. However,\nit is expected from the documentation to cover a successful operation response\nand any known errors.", "definitions": { @@ -85,42 +83,23 @@ "type": "string", "description": "The host (name or IP) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.", "markdownDescription": "The host (name or IP) serving the API. This MUST be the host only and does\nnot include the scheme nor sub-paths. It MAY include a port. If the host\nis not included, the host serving the documentation is to be used\n(including the port). The host does not support path templating.", - "examples": [ - "api.example.com", - "api.example.com:8080" - ] + "examples": ["api.example.com", "api.example.com:8080"] }, "basePath": { "type": "string", "description": "The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating.", "markdownDescription": "The base path on which the API is served, which is relative to the host.\nIf it is not included, the API is served directly under the host.\nThe value MUST start with a leading slash (/). The basePath does not\nsupport path templating.", - "examples": [ - "/v1", - "/api/v2" - ] + "examples": ["/v1", "/api/v2"] }, "schemes": { "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol of the API. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default scheme to be used is the one used to access the specification.", "markdownDescription": "The transfer protocol of the API. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default\nscheme to be used is the one used to access the specification.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "consumes": { "type": "array", @@ -129,15 +108,7 @@ }, "description": "A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can consume. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -146,15 +117,7 @@ }, "description": "A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can produce. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "paths": { "$ref": "#/definitions/Paths", @@ -221,10 +184,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -257,11 +217,7 @@ ] } }, - "required": [ - "info", - "paths", - "swagger" - ], + "required": ["info", "paths", "swagger"], "description": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.", "markdownDescription": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more." }, @@ -272,10 +228,7 @@ "type": "string", "description": "The title of the application. This field is required.", "markdownDescription": "The title of the application. This field is required.", - "examples": [ - "Swagger Sample App", - "My API" - ] + "examples": ["Swagger Sample App", "My API"] }, "description": { "type": "string", @@ -290,10 +243,7 @@ "type": "string", "description": "The Terms of Service for the API.", "markdownDescription": "The Terms of Service for the API.", - "examples": [ - "http://swagger.io/terms/", - "https://example.com/terms" - ] + "examples": ["http://swagger.io/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -321,16 +271,10 @@ "type": "string", "description": "Provides the version of the application API (not to be confused with the specification version). This field is required.", "markdownDescription": "Provides the version of the application API (not to be confused with the specification version).\nThis field is required.", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.", "markdownDescription": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients\nif needed, and can be presented in the Swagger-UI for convenience." }, @@ -341,28 +285,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.swagger.io/support", - "https://example.com/contact" - ] + "examples": ["http://www.swagger.io/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@swagger.io", - "contact@example.com" - ] + "examples": ["support@swagger.io", "contact@example.com"] } }, "description": "Contact Object\n\nContact information for the exposed API.", @@ -375,11 +310,7 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "MIT License", - "Apache License 2.0", - "Proprietary Foo License" - ] + "examples": ["MIT License", "Apache License 2.0", "Proprietary Foo License"] }, "url": { "type": "string", @@ -392,9 +323,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n-----\nFields\n-----" }, @@ -559,24 +488,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in swagger-ui, this field SHOULD be less than 120 characters.", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nswagger-ui, this field SHOULD be less than 120 characters.", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -601,10 +519,7 @@ "type": "string", "description": "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.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "consumes": { "type": "array", @@ -613,15 +528,7 @@ }, "description": "A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can consume. This overrides the consumes\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -630,15 +537,7 @@ }, "description": "A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can produce. This overrides the produces\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "parameters": { "type": "array", @@ -684,32 +583,17 @@ "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol for the operation. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object schemes definition.", "markdownDescription": "The transfer protocol for the operation. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object\nschemes definition.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "deprecated": { "type": "boolean", "description": "Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Usage of the declared operation\nshould be refrained. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -733,18 +617,13 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined by a combination of a path and an HTTP method.", "markdownDescription": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined\nby a combination of a path and an HTTP method." }, @@ -774,9 +653,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation. This object provides a way to link to additional documentation that supplements the API specification, such as detailed guides, tutorials, or reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\nThis object provides a way to link to additional documentation that\nsupplements the API specification, such as detailed guides, tutorials,\nor reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n-----\nFields\n-----" }, @@ -797,37 +674,26 @@ "type": "string", "description": "The name of the parameter. For body parameters, this is used for documentation purposes only and has no effect on the parameter itself.", "markdownDescription": "The name of the parameter. For body parameters, this is used for documentation\npurposes only and has no effect on the parameter itself.", - "examples": [ - "user", - "data", - "payload" - ] + "examples": ["user", "data", "payload"] }, "in": { "type": "string", "const": "body", "description": "The location of the parameter. Must be \"body\" for body parameters.", "markdownDescription": "The location of the parameter. Must be \"body\" for body parameters.", - "examples": [ - "body" - ] + "examples": ["body"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "User object to create", - "Request payload containing the data to process" - ] + "examples": ["User object to create", "Request payload containing the data to process"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. Default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "schema": { @@ -849,11 +715,7 @@ ] } }, - "required": [ - "name", - "in", - "schema" - ], + "required": ["name", "in", "schema"], "description": "----- Parameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent the payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload, which can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent\nthe payload that's appended to the HTTP request. Since there can only be one\npayload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload,\nwhich can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -895,20 +757,13 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate that this schema represents string data.", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate\nthat this schema represents string data.", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -923,11 +778,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -939,10 +790,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -951,23 +799,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -980,38 +814,26 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "maxLength": { "type": "number", "description": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", "markdownDescription": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", "markdownDescription": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "A string is valid against \"pattern\" if the regular expression matches the string successfully. The regular expression syntax follows ECMA 262.", "markdownDescription": "A string is valid against \"pattern\" if the regular expression matches the string successfully.\nThe regular expression syntax follows ECMA 262.", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1025,9 +847,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation rules. They are one of the most commonly used schema types in API specifications, used for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like email, date, and UUID, as well as custom formats defined by the API provider. They also support comprehensive validation through pattern matching, length constraints, and enumeration.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation\nrules. They are one of the most commonly used schema types in API specifications,\nused for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like\nemail, date, and UUID, as well as custom formats defined by the API provider.\nThey also support comprehensive validation through pattern matching, length\nconstraints, and enumeration.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1038,11 +858,7 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object, it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside\nthe items), it will affect the wrapping element and only if wrapped is true.", - "examples": [ - "animal", - "item", - "person" - ] + "examples": ["animal", "item", "person"] }, "namespace": { "type": "string", @@ -1058,30 +874,20 @@ "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "sample", - "xs", - "ex" - ] + "examples": ["sample", "xs", "ex"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ) or unwrapped ().\nDefault value is false. The definition takes effect only when defined alongside\ntype being array (outside the items).", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false } }, @@ -1096,20 +902,13 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate that this schema represents numeric data (both integers and floating-point).", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate\nthat this schema represents numeric data (both integers and floating-point).", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1124,11 +923,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1140,10 +935,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1152,23 +944,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1181,56 +959,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 0.01 - ] + "examples": [2, 0.01] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1244,9 +1004,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point numbers. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and other numeric data in APIs. They support range validation, precision control, and multiple format specifications.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point\nnumbers. They support various formats and validation rules to ensure data\nintegrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and\nother numeric data in APIs. They support range validation, precision control,\nand multiple format specifications.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1258,18 +1016,13 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate that this schema represents whole number data without fractional components.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate\nthat this schema represents whole number data without fractional components.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "description": { "type": "string", @@ -1284,11 +1037,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1300,10 +1049,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1312,23 +1058,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1341,56 +1073,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 1 - ] + "examples": [2, 1] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1404,9 +1118,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other discrete numeric values in APIs. They support range validation and multiple format specifications including int32 and int64.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components.\nThey support various formats and validation rules to ensure data integrity\nand provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other\ndiscrete numeric values in APIs. They support range validation and multiple\nformat specifications including int32 and int64.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1418,20 +1130,13 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate that this schema represents true/false values.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate\nthat this schema represents true/false values.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1446,11 +1151,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1462,10 +1163,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1474,23 +1172,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1503,10 +1187,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1521,9 +1202,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches, and other binary state indicators in APIs. They are simple but essential data types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators, configuration options, and other binary state representations. They support default values and examples to help API consumers understand the expected behavior.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches,\nand other binary state indicators in APIs. They are simple but essential\ndata types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators,\nconfiguration options, and other binary state representations. They support\ndefault values and examples to help API consumers understand the expected\nbehavior.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1535,20 +1214,13 @@ "const": "file", "description": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate that this schema represents file data. This is a Swagger 2.0 specific type that extends JSON Schema.", "markdownDescription": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate\nthat this schema represents file data. This is a Swagger 2.0 specific\ntype that extends JSON Schema.", - "examples": [ - "file" - ] + "examples": ["file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1563,11 +1235,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1579,10 +1247,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1591,23 +1256,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1620,10 +1271,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1638,9 +1286,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- File Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0 specific data type that extends the JSON Schema specification to support file operations. File schemas are used by Parameter and Response objects to indicate that the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing, image handling, and other file-based operations. They provide clear indication to API consumers that file data is expected or returned.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } | | 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nFile Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0\nspecific data type that extends the JSON Schema specification to support file\noperations. File schemas are used by Parameter and Response objects to indicate\nthat the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing,\nimage handling, and other file-based operations. They provide clear indication\nto API consumers that file data is expected or returned.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n| 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n-----\nFields\n-----" }, @@ -1652,9 +1298,7 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate that this schema represents an ordered collection of items.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate\nthat this schema represents an ordered collection of items.", - "examples": [ - "array" - ] + "examples": ["array"] }, "items": { "$ref": "#/definitions/Schema", @@ -1681,28 +1325,19 @@ "type": "number", "description": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", "markdownDescription": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", "markdownDescription": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "uniqueItems": { "type": "boolean", "description": "An array is valid against \"uniqueItems\" if all its elements are unique.", "markdownDescription": "An array is valid against \"uniqueItems\" if all its elements are unique.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1716,10 +1351,7 @@ ] } }, - "required": [ - "type", - "items" - ], + "required": ["type", "items"], "description": "----- Array Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms to a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific adjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs. They support validation of array length, item uniqueness, and item type constraints. The items property defines the schema that each array element must conform to.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms\nto a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific\nadjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs.\nThey support validation of array length, item uniqueness, and item type constraints.\nThe items property defines the schema that each array element must conform to.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1731,9 +1363,7 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate that this schema represents structured data with named properties.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate\nthat this schema represents structured data with named properties.", - "examples": [ - "object" - ] + "examples": ["object"] }, "properties": { "type": "object", @@ -1766,15 +1396,8 @@ "description": "A list of required properties. Properties marked as required being true MUST be present in the object.\n\nThis array contains the names of properties that must be present in any valid instance of this object schema. Properties not listed here are considered optional.", "markdownDescription": "A list of required properties. Properties marked as required being true\nMUST be present in the object.\n\nThis array contains the names of properties that must be present in\nany valid instance of this object schema. Properties not listed here\nare considered optional.", "examples": [ - [ - "name", - "email" - ], - [ - "id", - "type", - "createdAt" - ] + ["name", "email"], + ["id", "type", "createdAt"] ] }, "additionalProperties": { @@ -1821,19 +1444,13 @@ "type": "number", "description": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", "markdownDescription": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", "markdownDescription": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1867,9 +1484,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- JSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse. The Reference Object is a JSON Reference that uses a JSON Pointer as its value. For this specification, only canonical dereferencing is supported.\n\nJSON References enable reusability and modularity in API specifications by allowing the same definition to be referenced multiple times throughout the document. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } | | 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } | | 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n----- Fields\n-----", "markdownDescription": "-----\nJSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification.\nIt can be used to reference parameters and responses that are defined at the\ntop level for reuse. The Reference Object is a JSON Reference that uses a\nJSON Pointer as its value. For this specification, only canonical dereferencing\nis supported.\n\nJSON References enable reusability and modularity in API specifications by\nallowing the same definition to be referenced multiple times throughout the\ndocument. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } |\n| 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } |\n| 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n-----\nFields\n-----" @@ -1881,83 +1496,46 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "formData" - ], + "enum": ["query", "header", "path", "formData"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", - "examples": [ - "query", - "path", - "header", - "formData" - ] + "examples": ["query", "path", "header", "formData"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "The user ID", - "Maximum number of items to return (default: 10)" - ] + "examples": ["The user ID", "Maximum number of items to return (default: 10)"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. If the parameter is in \"path\", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter is in \"path\",\nthis property is required and its value MUST be true. Otherwise, the property\nMAY be included and its default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "type": { "type": "string", - "enum": [ - "string", - "number", - "integer", - "boolean", - "array", - "file" - ], + "enum": ["string", "number", "integer", "boolean", "array", "file"], "description": "The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\", the consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\" or both and the parameter MUST be in \"formData\".", "markdownDescription": "The type of the parameter. Since the parameter is not located at the request body,\nit is limited to simple types (that is, not an object). The value MUST be one of\n\"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\",\nthe consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\"\nor both and the parameter MUST be in \"formData\".", - "examples": [ - "string", - "integer", - "array", - "file" - ] + "examples": ["string", "integer", "array", "file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for either\nquery or formData parameters and allows you to send a parameter with a name only\nor an empty value. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -1976,135 +1554,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes", - "multi" - ], + "enum": ["csv", "ssv", "tsv", "pipes", "multi"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the parameter that the server will use if none is provided. This value MUST conform to the defined type for this parameter.", "markdownDescription": "Declares the value of the parameter that the server will use if none is provided.\nThis value MUST conform to the defined type for this parameter.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "name", - "in", - "type" - ], + "required": ["name", "in", "type"], "description": "----- Parameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include query, header, path, and formData parameters. They have different validation rules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file) and include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include\nquery, header, path, and formData parameters. They have different validation\nrules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file)\nand include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -2115,21 +1650,13 @@ "type": "string", "description": "The internal type of the array. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". Files and models are not allowed.", "markdownDescription": "The internal type of the array. The value MUST be one of \"string\", \"number\",\n\"integer\", \"boolean\", or \"array\". Files and models are not allowed.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2147,132 +1674,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the item that the server will use if none is provided. This value MUST conform to the defined type for the data type.", "markdownDescription": "Declares the value of the item that the server will use if none is provided.\nThis value MUST conform to the defined type for the data type.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in \"body\".", "markdownDescription": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions\nthat are not located in \"body\"." }, @@ -2671,9 +2158,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes because they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.", "markdownDescription": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected\nresponses of an operation. The container maps a HTTP response code to the expected\nresponse. It is not expected from the documentation to necessarily cover all\npossible HTTP response codes because they may not be known in advance. However,\nit is expected from the documentation to cover a successful operation response\nand any known errors." }, @@ -2684,30 +2169,19 @@ "type": "string", "description": "A brief description of the header. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the header. GFM syntax can be used for rich text representation.", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "type": { "type": "string", "description": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". This field is required.", "markdownDescription": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\",\n\"boolean\", or \"array\".\nThis field is required.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2725,132 +2199,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the header that the server will use if none is provided. This value MUST conform to the defined type for the header.", "markdownDescription": "Declares the value of the header that the server will use if none is provided.\nThis value MUST conform to the defined type for the header.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with the response. The name is used to refer to the respective header definition. The value of the header is of type string.", "markdownDescription": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with\nthe response. The name is used to refer to the respective header definition.\nThe value of the header is of type string." }, @@ -2934,65 +2368,36 @@ "properties": { "type": { "type": "string", - "enum": [ - "basic", - "apiKey", - "oauth2" - ], + "enum": ["basic", "apiKey", "oauth2"], "description": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\". This field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", "markdownDescription": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\".\nThis field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", - "examples": [ - "apiKey", - "oauth2", - "basic" - ] + "examples": ["apiKey", "oauth2", "basic"] }, "description": { "type": "string", "description": "A short description for security scheme. GFM syntax can be used for rich text representation.", "markdownDescription": "A short description for security scheme. GFM syntax can be used for rich text representation.", - "examples": [ - "API key for authentication", - "OAuth 2.0 with authorization code flow" - ] + "examples": ["API key for authentication", "OAuth 2.0 with authorization code flow"] }, "name": { "type": "string", "description": "The name of the header or query parameter to be used. This field is required for apiKey type and applies to apiKey type only.", "markdownDescription": "The name of the header or query parameter to be used. This field is required\nfor apiKey type and applies to apiKey type only.", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header" - ], + "enum": ["query", "header"], "description": "The location of the API key. This field is required for apiKey type and applies to apiKey type only. Valid values are \"query\" or \"header\".", "markdownDescription": "The location of the API key. This field is required for apiKey type and\napplies to apiKey type only. Valid values are \"query\" or \"header\".", - "examples": [ - "header", - "query" - ] + "examples": ["header", "query"] }, "flow": { "type": "string", - "enum": [ - "implicit", - "password", - "application", - "accessCode" - ], + "enum": ["implicit", "password", "application", "accessCode"], "description": "The flow used by the OAuth2 security scheme. This field is required for oauth2 type and applies to oauth2 type only. Valid values are \"implicit\", \"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", "markdownDescription": "The flow used by the OAuth2 security scheme. This field is required for\noauth2 type and applies to oauth2 type only. Valid values are \"implicit\",\n\"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", - "examples": [ - "accessCode", - "implicit", - "password" - ] + "examples": ["accessCode", "implicit", "password"] }, "authorizationUrl": { "type": "string", @@ -3007,10 +2412,7 @@ "type": "string", "description": "The token URL to be used for this flow. This SHOULD be in the form of a URL. This field is required for oauth2 type and applies to oauth2 type only.", "markdownDescription": "The token URL to be used for this flow. This SHOULD be in the form of a URL.\nThis field is required for oauth2 type and applies to oauth2 type only.", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "scopes": { "$ref": "#/definitions/Scopes", @@ -3027,9 +2429,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).", "markdownDescription": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare basic authentication, an API key (either as a header or as a query parameter)\nand OAuth2's common flows (implicit, password, application and access code)." }, @@ -3066,10 +2466,7 @@ "api_key": [] }, { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] }, @@ -3083,12 +2480,7 @@ "type": "string", "description": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and must be unique within the entire specification. It should be descriptive and follow a consistent naming convention.", "markdownDescription": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and\nmust be unique within the entire specification. It should be descriptive\nand follow a consistent naming convention.", - "examples": [ - "users", - "pets", - "authentication", - "reports" - ] + "examples": ["users", "pets", "authentication", "reports"] }, "description": { "type": "string", @@ -3116,11 +2508,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations by resources or any other qualifier. 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.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations\nby resources or any other qualifier. The order of the tags can be used to reflect\non their order by the parsing tools. Not all tags that are used by the Operation\nObject must be declared. The tags that are not declared may be organized randomly\nor based on the tools' logic. Each tag name in the list MUST be unique.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/2.0/components/schema.json b/schemas/2.0/components/schema.json index ec895ab..678e715 100644 --- a/schemas/2.0/components/schema.json +++ b/schemas/2.0/components/schema.json @@ -47,42 +47,23 @@ "type": "string", "description": "The host (name or IP) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.", "markdownDescription": "The host (name or IP) serving the API. This MUST be the host only and does\nnot include the scheme nor sub-paths. It MAY include a port. If the host\nis not included, the host serving the documentation is to be used\n(including the port). The host does not support path templating.", - "examples": [ - "api.example.com", - "api.example.com:8080" - ] + "examples": ["api.example.com", "api.example.com:8080"] }, "basePath": { "type": "string", "description": "The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating.", "markdownDescription": "The base path on which the API is served, which is relative to the host.\nIf it is not included, the API is served directly under the host.\nThe value MUST start with a leading slash (/). The basePath does not\nsupport path templating.", - "examples": [ - "/v1", - "/api/v2" - ] + "examples": ["/v1", "/api/v2"] }, "schemes": { "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol of the API. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default scheme to be used is the one used to access the specification.", "markdownDescription": "The transfer protocol of the API. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default\nscheme to be used is the one used to access the specification.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "consumes": { "type": "array", @@ -91,15 +72,7 @@ }, "description": "A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can consume. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -108,15 +81,7 @@ }, "description": "A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can produce. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "paths": { "$ref": "#/definitions/Paths", @@ -183,10 +148,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -219,11 +181,7 @@ ] } }, - "required": [ - "info", - "paths", - "swagger" - ], + "required": ["info", "paths", "swagger"], "description": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.", "markdownDescription": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more." }, @@ -234,10 +192,7 @@ "type": "string", "description": "The title of the application. This field is required.", "markdownDescription": "The title of the application. This field is required.", - "examples": [ - "Swagger Sample App", - "My API" - ] + "examples": ["Swagger Sample App", "My API"] }, "description": { "type": "string", @@ -252,10 +207,7 @@ "type": "string", "description": "The Terms of Service for the API.", "markdownDescription": "The Terms of Service for the API.", - "examples": [ - "http://swagger.io/terms/", - "https://example.com/terms" - ] + "examples": ["http://swagger.io/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -283,16 +235,10 @@ "type": "string", "description": "Provides the version of the application API (not to be confused with the specification version). This field is required.", "markdownDescription": "Provides the version of the application API (not to be confused with the specification version).\nThis field is required.", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.", "markdownDescription": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients\nif needed, and can be presented in the Swagger-UI for convenience." }, @@ -303,28 +249,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.swagger.io/support", - "https://example.com/contact" - ] + "examples": ["http://www.swagger.io/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@swagger.io", - "contact@example.com" - ] + "examples": ["support@swagger.io", "contact@example.com"] } }, "description": "Contact Object\n\nContact information for the exposed API.", @@ -337,11 +274,7 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "MIT License", - "Apache License 2.0", - "Proprietary Foo License" - ] + "examples": ["MIT License", "Apache License 2.0", "Proprietary Foo License"] }, "url": { "type": "string", @@ -354,9 +287,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n-----\nFields\n-----" }, @@ -521,24 +452,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in swagger-ui, this field SHOULD be less than 120 characters.", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nswagger-ui, this field SHOULD be less than 120 characters.", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -563,10 +483,7 @@ "type": "string", "description": "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.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "consumes": { "type": "array", @@ -575,15 +492,7 @@ }, "description": "A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can consume. This overrides the consumes\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -592,15 +501,7 @@ }, "description": "A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can produce. This overrides the produces\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "parameters": { "type": "array", @@ -646,32 +547,17 @@ "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol for the operation. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object schemes definition.", "markdownDescription": "The transfer protocol for the operation. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object\nschemes definition.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "deprecated": { "type": "boolean", "description": "Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Usage of the declared operation\nshould be refrained. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -695,18 +581,13 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined by a combination of a path and an HTTP method.", "markdownDescription": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined\nby a combination of a path and an HTTP method." }, @@ -736,9 +617,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation. This object provides a way to link to additional documentation that supplements the API specification, such as detailed guides, tutorials, or reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\nThis object provides a way to link to additional documentation that\nsupplements the API specification, such as detailed guides, tutorials,\nor reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n-----\nFields\n-----" }, @@ -759,37 +638,26 @@ "type": "string", "description": "The name of the parameter. For body parameters, this is used for documentation purposes only and has no effect on the parameter itself.", "markdownDescription": "The name of the parameter. For body parameters, this is used for documentation\npurposes only and has no effect on the parameter itself.", - "examples": [ - "user", - "data", - "payload" - ] + "examples": ["user", "data", "payload"] }, "in": { "type": "string", "const": "body", "description": "The location of the parameter. Must be \"body\" for body parameters.", "markdownDescription": "The location of the parameter. Must be \"body\" for body parameters.", - "examples": [ - "body" - ] + "examples": ["body"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "User object to create", - "Request payload containing the data to process" - ] + "examples": ["User object to create", "Request payload containing the data to process"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. Default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "schema": { @@ -811,11 +679,7 @@ ] } }, - "required": [ - "name", - "in", - "schema" - ], + "required": ["name", "in", "schema"], "description": "----- Parameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent the payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload, which can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent\nthe payload that's appended to the HTTP request. Since there can only be one\npayload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload,\nwhich can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -857,20 +721,13 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate that this schema represents string data.", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate\nthat this schema represents string data.", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -885,11 +742,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -901,10 +754,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -913,23 +763,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -942,38 +778,26 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "maxLength": { "type": "number", "description": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", "markdownDescription": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", "markdownDescription": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "A string is valid against \"pattern\" if the regular expression matches the string successfully. The regular expression syntax follows ECMA 262.", "markdownDescription": "A string is valid against \"pattern\" if the regular expression matches the string successfully.\nThe regular expression syntax follows ECMA 262.", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -987,9 +811,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation rules. They are one of the most commonly used schema types in API specifications, used for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like email, date, and UUID, as well as custom formats defined by the API provider. They also support comprehensive validation through pattern matching, length constraints, and enumeration.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation\nrules. They are one of the most commonly used schema types in API specifications,\nused for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like\nemail, date, and UUID, as well as custom formats defined by the API provider.\nThey also support comprehensive validation through pattern matching, length\nconstraints, and enumeration.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1000,11 +822,7 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object, it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside\nthe items), it will affect the wrapping element and only if wrapped is true.", - "examples": [ - "animal", - "item", - "person" - ] + "examples": ["animal", "item", "person"] }, "namespace": { "type": "string", @@ -1020,30 +838,20 @@ "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "sample", - "xs", - "ex" - ] + "examples": ["sample", "xs", "ex"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ) or unwrapped ().\nDefault value is false. The definition takes effect only when defined alongside\ntype being array (outside the items).", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false } }, @@ -1058,20 +866,13 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate that this schema represents numeric data (both integers and floating-point).", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate\nthat this schema represents numeric data (both integers and floating-point).", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1086,11 +887,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1102,10 +899,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1114,23 +908,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1143,56 +923,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 0.01 - ] + "examples": [2, 0.01] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1206,9 +968,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point numbers. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and other numeric data in APIs. They support range validation, precision control, and multiple format specifications.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point\nnumbers. They support various formats and validation rules to ensure data\nintegrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and\nother numeric data in APIs. They support range validation, precision control,\nand multiple format specifications.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1220,18 +980,13 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate that this schema represents whole number data without fractional components.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate\nthat this schema represents whole number data without fractional components.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "description": { "type": "string", @@ -1246,11 +1001,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1262,10 +1013,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1274,23 +1022,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1303,56 +1037,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 1 - ] + "examples": [2, 1] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1366,9 +1082,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other discrete numeric values in APIs. They support range validation and multiple format specifications including int32 and int64.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components.\nThey support various formats and validation rules to ensure data integrity\nand provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other\ndiscrete numeric values in APIs. They support range validation and multiple\nformat specifications including int32 and int64.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1380,20 +1094,13 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate that this schema represents true/false values.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate\nthat this schema represents true/false values.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1408,11 +1115,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1424,10 +1127,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1436,23 +1136,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1465,10 +1151,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1483,9 +1166,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches, and other binary state indicators in APIs. They are simple but essential data types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators, configuration options, and other binary state representations. They support default values and examples to help API consumers understand the expected behavior.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches,\nand other binary state indicators in APIs. They are simple but essential\ndata types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators,\nconfiguration options, and other binary state representations. They support\ndefault values and examples to help API consumers understand the expected\nbehavior.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1497,20 +1178,13 @@ "const": "file", "description": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate that this schema represents file data. This is a Swagger 2.0 specific type that extends JSON Schema.", "markdownDescription": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate\nthat this schema represents file data. This is a Swagger 2.0 specific\ntype that extends JSON Schema.", - "examples": [ - "file" - ] + "examples": ["file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1525,11 +1199,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1541,10 +1211,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1553,23 +1220,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1582,10 +1235,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1600,9 +1250,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- File Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0 specific data type that extends the JSON Schema specification to support file operations. File schemas are used by Parameter and Response objects to indicate that the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing, image handling, and other file-based operations. They provide clear indication to API consumers that file data is expected or returned.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } | | 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nFile Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0\nspecific data type that extends the JSON Schema specification to support file\noperations. File schemas are used by Parameter and Response objects to indicate\nthat the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing,\nimage handling, and other file-based operations. They provide clear indication\nto API consumers that file data is expected or returned.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n| 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n-----\nFields\n-----" }, @@ -1614,9 +1262,7 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate that this schema represents an ordered collection of items.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate\nthat this schema represents an ordered collection of items.", - "examples": [ - "array" - ] + "examples": ["array"] }, "items": { "$ref": "#/definitions/Schema", @@ -1643,28 +1289,19 @@ "type": "number", "description": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", "markdownDescription": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", "markdownDescription": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "uniqueItems": { "type": "boolean", "description": "An array is valid against \"uniqueItems\" if all its elements are unique.", "markdownDescription": "An array is valid against \"uniqueItems\" if all its elements are unique.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1678,10 +1315,7 @@ ] } }, - "required": [ - "type", - "items" - ], + "required": ["type", "items"], "description": "----- Array Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms to a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific adjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs. They support validation of array length, item uniqueness, and item type constraints. The items property defines the schema that each array element must conform to.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms\nto a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific\nadjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs.\nThey support validation of array length, item uniqueness, and item type constraints.\nThe items property defines the schema that each array element must conform to.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1693,9 +1327,7 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate that this schema represents structured data with named properties.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate\nthat this schema represents structured data with named properties.", - "examples": [ - "object" - ] + "examples": ["object"] }, "properties": { "type": "object", @@ -1728,15 +1360,8 @@ "description": "A list of required properties. Properties marked as required being true MUST be present in the object.\n\nThis array contains the names of properties that must be present in any valid instance of this object schema. Properties not listed here are considered optional.", "markdownDescription": "A list of required properties. Properties marked as required being true\nMUST be present in the object.\n\nThis array contains the names of properties that must be present in\nany valid instance of this object schema. Properties not listed here\nare considered optional.", "examples": [ - [ - "name", - "email" - ], - [ - "id", - "type", - "createdAt" - ] + ["name", "email"], + ["id", "type", "createdAt"] ] }, "additionalProperties": { @@ -1783,19 +1408,13 @@ "type": "number", "description": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", "markdownDescription": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", "markdownDescription": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1829,9 +1448,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- JSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse. The Reference Object is a JSON Reference that uses a JSON Pointer as its value. For this specification, only canonical dereferencing is supported.\n\nJSON References enable reusability and modularity in API specifications by allowing the same definition to be referenced multiple times throughout the document. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } | | 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } | | 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n----- Fields\n-----", "markdownDescription": "-----\nJSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification.\nIt can be used to reference parameters and responses that are defined at the\ntop level for reuse. The Reference Object is a JSON Reference that uses a\nJSON Pointer as its value. For this specification, only canonical dereferencing\nis supported.\n\nJSON References enable reusability and modularity in API specifications by\nallowing the same definition to be referenced multiple times throughout the\ndocument. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } |\n| 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } |\n| 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n-----\nFields\n-----" @@ -1843,83 +1460,46 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "formData" - ], + "enum": ["query", "header", "path", "formData"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", - "examples": [ - "query", - "path", - "header", - "formData" - ] + "examples": ["query", "path", "header", "formData"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "The user ID", - "Maximum number of items to return (default: 10)" - ] + "examples": ["The user ID", "Maximum number of items to return (default: 10)"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. If the parameter is in \"path\", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter is in \"path\",\nthis property is required and its value MUST be true. Otherwise, the property\nMAY be included and its default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "type": { "type": "string", - "enum": [ - "string", - "number", - "integer", - "boolean", - "array", - "file" - ], + "enum": ["string", "number", "integer", "boolean", "array", "file"], "description": "The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\", the consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\" or both and the parameter MUST be in \"formData\".", "markdownDescription": "The type of the parameter. Since the parameter is not located at the request body,\nit is limited to simple types (that is, not an object). The value MUST be one of\n\"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\",\nthe consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\"\nor both and the parameter MUST be in \"formData\".", - "examples": [ - "string", - "integer", - "array", - "file" - ] + "examples": ["string", "integer", "array", "file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for either\nquery or formData parameters and allows you to send a parameter with a name only\nor an empty value. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -1938,135 +1518,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes", - "multi" - ], + "enum": ["csv", "ssv", "tsv", "pipes", "multi"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the parameter that the server will use if none is provided. This value MUST conform to the defined type for this parameter.", "markdownDescription": "Declares the value of the parameter that the server will use if none is provided.\nThis value MUST conform to the defined type for this parameter.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "name", - "in", - "type" - ], + "required": ["name", "in", "type"], "description": "----- Parameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include query, header, path, and formData parameters. They have different validation rules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file) and include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include\nquery, header, path, and formData parameters. They have different validation\nrules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file)\nand include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -2077,21 +1614,13 @@ "type": "string", "description": "The internal type of the array. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". Files and models are not allowed.", "markdownDescription": "The internal type of the array. The value MUST be one of \"string\", \"number\",\n\"integer\", \"boolean\", or \"array\". Files and models are not allowed.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2109,132 +1638,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the item that the server will use if none is provided. This value MUST conform to the defined type for the data type.", "markdownDescription": "Declares the value of the item that the server will use if none is provided.\nThis value MUST conform to the defined type for the data type.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in \"body\".", "markdownDescription": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions\nthat are not located in \"body\"." }, @@ -2633,9 +2122,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes because they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.", "markdownDescription": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected\nresponses of an operation. The container maps a HTTP response code to the expected\nresponse. It is not expected from the documentation to necessarily cover all\npossible HTTP response codes because they may not be known in advance. However,\nit is expected from the documentation to cover a successful operation response\nand any known errors." }, @@ -2646,30 +2133,19 @@ "type": "string", "description": "A brief description of the header. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the header. GFM syntax can be used for rich text representation.", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "type": { "type": "string", "description": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". This field is required.", "markdownDescription": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\",\n\"boolean\", or \"array\".\nThis field is required.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2687,132 +2163,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the header that the server will use if none is provided. This value MUST conform to the defined type for the header.", "markdownDescription": "Declares the value of the header that the server will use if none is provided.\nThis value MUST conform to the defined type for the header.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with the response. The name is used to refer to the respective header definition. The value of the header is of type string.", "markdownDescription": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with\nthe response. The name is used to refer to the respective header definition.\nThe value of the header is of type string." }, @@ -2896,65 +2332,36 @@ "properties": { "type": { "type": "string", - "enum": [ - "basic", - "apiKey", - "oauth2" - ], + "enum": ["basic", "apiKey", "oauth2"], "description": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\". This field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", "markdownDescription": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\".\nThis field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", - "examples": [ - "apiKey", - "oauth2", - "basic" - ] + "examples": ["apiKey", "oauth2", "basic"] }, "description": { "type": "string", "description": "A short description for security scheme. GFM syntax can be used for rich text representation.", "markdownDescription": "A short description for security scheme. GFM syntax can be used for rich text representation.", - "examples": [ - "API key for authentication", - "OAuth 2.0 with authorization code flow" - ] + "examples": ["API key for authentication", "OAuth 2.0 with authorization code flow"] }, "name": { "type": "string", "description": "The name of the header or query parameter to be used. This field is required for apiKey type and applies to apiKey type only.", "markdownDescription": "The name of the header or query parameter to be used. This field is required\nfor apiKey type and applies to apiKey type only.", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header" - ], + "enum": ["query", "header"], "description": "The location of the API key. This field is required for apiKey type and applies to apiKey type only. Valid values are \"query\" or \"header\".", "markdownDescription": "The location of the API key. This field is required for apiKey type and\napplies to apiKey type only. Valid values are \"query\" or \"header\".", - "examples": [ - "header", - "query" - ] + "examples": ["header", "query"] }, "flow": { "type": "string", - "enum": [ - "implicit", - "password", - "application", - "accessCode" - ], + "enum": ["implicit", "password", "application", "accessCode"], "description": "The flow used by the OAuth2 security scheme. This field is required for oauth2 type and applies to oauth2 type only. Valid values are \"implicit\", \"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", "markdownDescription": "The flow used by the OAuth2 security scheme. This field is required for\noauth2 type and applies to oauth2 type only. Valid values are \"implicit\",\n\"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", - "examples": [ - "accessCode", - "implicit", - "password" - ] + "examples": ["accessCode", "implicit", "password"] }, "authorizationUrl": { "type": "string", @@ -2969,10 +2376,7 @@ "type": "string", "description": "The token URL to be used for this flow. This SHOULD be in the form of a URL. This field is required for oauth2 type and applies to oauth2 type only.", "markdownDescription": "The token URL to be used for this flow. This SHOULD be in the form of a URL.\nThis field is required for oauth2 type and applies to oauth2 type only.", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "scopes": { "$ref": "#/definitions/Scopes", @@ -2989,9 +2393,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).", "markdownDescription": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare basic authentication, an API key (either as a header or as a query parameter)\nand OAuth2's common flows (implicit, password, application and access code)." }, @@ -3028,10 +2430,7 @@ "api_key": [] }, { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] }, @@ -3045,12 +2444,7 @@ "type": "string", "description": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and must be unique within the entire specification. It should be descriptive and follow a consistent naming convention.", "markdownDescription": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and\nmust be unique within the entire specification. It should be descriptive\nand follow a consistent naming convention.", - "examples": [ - "users", - "pets", - "authentication", - "reports" - ] + "examples": ["users", "pets", "authentication", "reports"] }, "description": { "type": "string", @@ -3078,11 +2472,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations by resources or any other qualifier. 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.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations\nby resources or any other qualifier. The order of the tags can be used to reflect\non their order by the parsing tools. Not all tags that are used by the Operation\nObject must be declared. The tags that are not declared may be organized randomly\nor based on the tools' logic. Each tag name in the list MUST be unique.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/2.0/index.ts b/schemas/2.0/index.ts index a4ab6f3..1f13ccf 100644 --- a/schemas/2.0/index.ts +++ b/schemas/2.0/index.ts @@ -28,4 +28,3 @@ export const schemas = { schema, pathitem, } as const; - diff --git a/schemas/2.0/main/specification.json b/schemas/2.0/main/specification.json index d59a1d3..2d70066 100644 --- a/schemas/2.0/main/specification.json +++ b/schemas/2.0/main/specification.json @@ -17,42 +17,23 @@ "type": "string", "description": "The host (name or IP) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.", "markdownDescription": "The host (name or IP) serving the API. This MUST be the host only and does\nnot include the scheme nor sub-paths. It MAY include a port. If the host\nis not included, the host serving the documentation is to be used\n(including the port). The host does not support path templating.", - "examples": [ - "api.example.com", - "api.example.com:8080" - ] + "examples": ["api.example.com", "api.example.com:8080"] }, "basePath": { "type": "string", "description": "The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating.", "markdownDescription": "The base path on which the API is served, which is relative to the host.\nIf it is not included, the API is served directly under the host.\nThe value MUST start with a leading slash (/). The basePath does not\nsupport path templating.", - "examples": [ - "/v1", - "/api/v2" - ] + "examples": ["/v1", "/api/v2"] }, "schemes": { "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol of the API. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default scheme to be used is the one used to access the specification.", "markdownDescription": "The transfer protocol of the API. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default\nscheme to be used is the one used to access the specification.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "consumes": { "type": "array", @@ -61,15 +42,7 @@ }, "description": "A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can consume. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -78,15 +51,7 @@ }, "description": "A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can produce. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "paths": { "$ref": "#/definitions/Paths", @@ -153,10 +118,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -189,11 +151,7 @@ ] } }, - "required": [ - "info", - "paths", - "swagger" - ], + "required": ["info", "paths", "swagger"], "description": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.", "markdownDescription": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.", "definitions": { @@ -215,42 +173,23 @@ "type": "string", "description": "The host (name or IP) serving the API. This MUST be the host only and does not include the scheme nor sub-paths. It MAY include a port. If the host is not included, the host serving the documentation is to be used (including the port). The host does not support path templating.", "markdownDescription": "The host (name or IP) serving the API. This MUST be the host only and does\nnot include the scheme nor sub-paths. It MAY include a port. If the host\nis not included, the host serving the documentation is to be used\n(including the port). The host does not support path templating.", - "examples": [ - "api.example.com", - "api.example.com:8080" - ] + "examples": ["api.example.com", "api.example.com:8080"] }, "basePath": { "type": "string", "description": "The base path on which the API is served, which is relative to the host. If it is not included, the API is served directly under the host. The value MUST start with a leading slash (/). The basePath does not support path templating.", "markdownDescription": "The base path on which the API is served, which is relative to the host.\nIf it is not included, the API is served directly under the host.\nThe value MUST start with a leading slash (/). The basePath does not\nsupport path templating.", - "examples": [ - "/v1", - "/api/v2" - ] + "examples": ["/v1", "/api/v2"] }, "schemes": { "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol of the API. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default scheme to be used is the one used to access the specification.", "markdownDescription": "The transfer protocol of the API. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". If the schemes is not included, the default\nscheme to be used is the one used to access the specification.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "consumes": { "type": "array", @@ -259,15 +198,7 @@ }, "description": "A list of MIME types the APIs can consume. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can consume. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -276,15 +207,7 @@ }, "description": "A list of MIME types the APIs can produce. This is global to all APIs but can be overridden on specific API calls. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the APIs can produce. This is global to all APIs\nbut can be overridden on specific API calls. Value MUST be as described\nunder Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "paths": { "$ref": "#/definitions/Paths", @@ -351,10 +274,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -387,11 +307,7 @@ ] } }, - "required": [ - "info", - "paths", - "swagger" - ], + "required": ["info", "paths", "swagger"], "description": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.", "markdownDescription": "Root Swagger 2.0 Schema (Swagger Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Draft 4 and uses a predefined subset of it.\n\nThe Swagger Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more." }, @@ -402,10 +318,7 @@ "type": "string", "description": "The title of the application. This field is required.", "markdownDescription": "The title of the application. This field is required.", - "examples": [ - "Swagger Sample App", - "My API" - ] + "examples": ["Swagger Sample App", "My API"] }, "description": { "type": "string", @@ -420,10 +333,7 @@ "type": "string", "description": "The Terms of Service for the API.", "markdownDescription": "The Terms of Service for the API.", - "examples": [ - "http://swagger.io/terms/", - "https://example.com/terms" - ] + "examples": ["http://swagger.io/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -451,16 +361,10 @@ "type": "string", "description": "Provides the version of the application API (not to be confused with the specification version). This field is required.", "markdownDescription": "Provides the version of the application API (not to be confused with the specification version).\nThis field is required.", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.", "markdownDescription": "Info Object\n\nThe object provides metadata about the API. The metadata can be used by the clients\nif needed, and can be presented in the Swagger-UI for convenience." }, @@ -471,28 +375,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.swagger.io/support", - "https://example.com/contact" - ] + "examples": ["http://www.swagger.io/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@swagger.io", - "contact@example.com" - ] + "examples": ["support@swagger.io", "contact@example.com"] } }, "description": "Contact Object\n\nContact information for the exposed API.", @@ -505,11 +400,7 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "MIT License", - "Apache License 2.0", - "Proprietary Foo License" - ] + "examples": ["MIT License", "Apache License 2.0", "Proprietary Foo License"] }, "url": { "type": "string", @@ -522,9 +413,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#license-object Swagger 2.0 License } |\n\n-----\nFields\n-----" }, @@ -689,24 +578,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in swagger-ui, this field SHOULD be less than 120 characters.", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nswagger-ui, this field SHOULD be less than 120 characters.", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -731,10 +609,7 @@ "type": "string", "description": "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.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "consumes": { "type": "array", @@ -743,15 +618,7 @@ }, "description": "A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can consume. This overrides the consumes\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "produces": { "type": "array", @@ -760,15 +627,7 @@ }, "description": "A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object level. An empty value MAY be used to clear the global definition. Value MUST be as described under Mime Types.", "markdownDescription": "A list of MIME types the operation can produce. This overrides the produces\ndefinition at the Swagger Object level. An empty value MAY be used to clear\nthe global definition. Value MUST be as described under Mime Types.", - "examples": [ - [ - "application/json" - ], - [ - "application/xml", - "application/json" - ] - ] + "examples": [["application/json"], ["application/xml", "application/json"]] }, "parameters": { "type": "array", @@ -814,32 +673,17 @@ "type": "array", "items": { "type": "string", - "enum": [ - "http", - "https", - "ws", - "wss" - ] + "enum": ["http", "https", "ws", "wss"] }, "description": "The transfer protocol for the operation. Values MUST be from the list: \"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object schemes definition.", "markdownDescription": "The transfer protocol for the operation. Values MUST be from the list:\n\"http\", \"https\", \"ws\", \"wss\". The value overrides the Swagger Object\nschemes definition.", - "examples": [ - [ - "https", - "http" - ], - [ - "wss" - ] - ] + "examples": [["https", "http"], ["wss"]] }, "deprecated": { "type": "boolean", "description": "Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Usage of the declared operation\nshould be refrained. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -863,18 +707,13 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined by a combination of a path and an HTTP method.", "markdownDescription": "Operation Object\n\nDescribes a single API operation on a path. A unique operation is defined\nby a combination of a path and an HTTP method." }, @@ -904,9 +743,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation. This object provides a way to link to additional documentation that supplements the API specification, such as detailed guides, tutorials, or reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\nThis object provides a way to link to additional documentation that\nsupplements the API specification, such as detailed guides, tutorials,\nor reference materials.\n\nExternal documentation is commonly used to provide:\n- Detailed API guides and tutorials\n- SDK documentation and examples\n- Integration guides and best practices\n- Additional reference materials\n- Community resources and support\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#external-documentation-object Swagger 2.0 External Documentation Object } |\n\n-----\nFields\n-----" }, @@ -927,37 +764,26 @@ "type": "string", "description": "The name of the parameter. For body parameters, this is used for documentation purposes only and has no effect on the parameter itself.", "markdownDescription": "The name of the parameter. For body parameters, this is used for documentation\npurposes only and has no effect on the parameter itself.", - "examples": [ - "user", - "data", - "payload" - ] + "examples": ["user", "data", "payload"] }, "in": { "type": "string", "const": "body", "description": "The location of the parameter. Must be \"body\" for body parameters.", "markdownDescription": "The location of the parameter. Must be \"body\" for body parameters.", - "examples": [ - "body" - ] + "examples": ["body"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "User object to create", - "Request payload containing the data to process" - ] + "examples": ["User object to create", "Request payload containing the data to process"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. Default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "schema": { @@ -979,11 +805,7 @@ ] } }, - "required": [ - "name", - "in", - "schema" - ], + "required": ["name", "in", "schema"], "description": "----- Parameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent the payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload, which can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Body Parameter)\n-----\n\nDescribes a body parameter for an API operation. Body parameters represent\nthe payload that's appended to the HTTP request. Since there can only be one\npayload, there can only be one body parameter per operation.\n\nBody parameters use a schema to define the structure of the request payload,\nwhich can be any valid Swagger schema including objects, arrays, and primitives.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -1025,20 +847,13 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate that this schema represents string data.", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n\nThis property is required and must be set to \"string\" to indicate\nthat this schema represents string data.", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1053,11 +868,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1069,10 +880,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1081,23 +889,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1110,38 +904,26 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "maxLength": { "type": "number", "description": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", "markdownDescription": "A string is valid against \"maxLength\" if its length is less than or equal to this value.", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", "markdownDescription": "A string is valid against \"minLength\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "A string is valid against \"pattern\" if the regular expression matches the string successfully. The regular expression syntax follows ECMA 262.", "markdownDescription": "A string is valid against \"pattern\" if the regular expression matches the string successfully.\nThe regular expression syntax follows ECMA 262.", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1155,9 +937,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation rules. They are one of the most commonly used schema types in API specifications, used for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like email, date, and UUID, as well as custom formats defined by the API provider. They also support comprehensive validation through pattern matching, length constraints, and enumeration.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nSchema for string data types in Swagger 2.0.\n\nString schemas represent textual data and support various formats and validation\nrules. They are one of the most commonly used schema types in API specifications,\nused for names, descriptions, identifiers, and other text-based data.\n\nString schemas support a wide range of formats including standard formats like\nemail, date, and UUID, as well as custom formats defined by the API provider.\nThey also support comprehensive validation through pattern matching, length\nconstraints, and enumeration.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1168,11 +948,7 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object, it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside\nthe items), it will affect the wrapping element and only if wrapped is true.", - "examples": [ - "animal", - "item", - "person" - ] + "examples": ["animal", "item", "person"] }, "namespace": { "type": "string", @@ -1188,30 +964,20 @@ "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "sample", - "xs", - "ex" - ] + "examples": ["sample", "xs", "ex"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ) or unwrapped ().\nDefault value is false. The definition takes effect only when defined alongside\ntype being array (outside the items).", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false } }, @@ -1226,20 +992,13 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate that this schema represents numeric data (both integers and floating-point).", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.\n\nThis property is required and must be set to \"number\" to indicate\nthat this schema represents numeric data (both integers and floating-point).", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1254,11 +1013,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1270,10 +1025,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1282,23 +1034,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1311,56 +1049,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 0.01 - ] + "examples": [2, 0.01] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1374,9 +1094,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point numbers. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and other numeric data in APIs. They support range validation, precision control, and multiple format specifications.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nSchema for number data types in Swagger 2.0.\n\nNumber schemas represent numeric data including both integers and floating-point\nnumbers. They support various formats and validation rules to ensure data\nintegrity and provide meaningful constraints for numeric values.\n\nNumber schemas are commonly used for quantities, prices, measurements, and\nother numeric data in APIs. They support range validation, precision control,\nand multiple format specifications.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1388,18 +1106,13 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate that this schema represents whole number data without fractional components.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.\n\nThis property is required and must be set to \"integer\" to indicate\nthat this schema represents whole number data without fractional components.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "description": { "type": "string", @@ -1414,11 +1127,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1430,10 +1139,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1442,23 +1148,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1471,56 +1163,38 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 2, - 1 - ] + "examples": [2, 1] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "boolean", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "boolean", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - false, - true - ] + "examples": [false, true] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1534,9 +1208,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components. They support various formats and validation rules to ensure data integrity and provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other discrete numeric values in APIs. They support range validation and multiple format specifications including int32 and int64.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nSchema for integer data types in Swagger 2.0.\n\nInteger schemas represent whole numbers without fractional components.\nThey support various formats and validation rules to ensure data integrity\nand provide meaningful constraints for integer values.\n\nInteger schemas are commonly used for counts, IDs, timestamps, and other\ndiscrete numeric values in APIs. They support range validation and multiple\nformat specifications including int32 and int64.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1548,20 +1220,13 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate that this schema represents true/false values.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.\n\nThis property is required and must be set to \"boolean\" to indicate\nthat this schema represents true/false values.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1576,11 +1241,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1592,10 +1253,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1604,23 +1262,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1633,10 +1277,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1651,9 +1292,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches, and other binary state indicators in APIs. They are simple but essential data types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators, configuration options, and other binary state representations. They support default values and examples to help API consumers understand the expected behavior.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nSchema for boolean data types in Swagger 2.0.\n\nBoolean schemas represent true/false values and are used for flags, switches,\nand other binary state indicators in APIs. They are simple but essential\ndata types that provide clear semantic meaning for binary choices.\n\nBoolean schemas are commonly used for feature flags, status indicators,\nconfiguration options, and other binary state representations. They support\ndefault values and examples to help API consumers understand the expected\nbehavior.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1665,20 +1304,13 @@ "const": "file", "description": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate that this schema represents file data. This is a Swagger 2.0 specific type that extends JSON Schema.", "markdownDescription": "The type of the schema. Must be \"file\" for file schemas.\n\nThis property is required and must be set to \"file\" to indicate\nthat this schema represents file data. This is a Swagger 2.0 specific\ntype that extends JSON Schema.", - "examples": [ - "file" - ] + "examples": ["file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type, enabling more precise validation and better tooling support. Swagger 2.0 defines several standard formats, but custom formats are also allowed.", "markdownDescription": "The extending format for the previously mentioned type.\nSee Swagger 2.0 Data Type Formats for further details.\n\nFormats provide additional semantic information about the data type,\nenabling more precise validation and better tooling support. Swagger 2.0\ndefines several standard formats, but custom formats are also allowed.", - "examples": [ - "int32", - "date", - "email", - "uuid" - ] + "examples": ["int32", "date", "email", "uuid"] }, "description": { "type": "string", @@ -1693,11 +1325,7 @@ "type": "string", "description": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used in documentation and UI displays. It should be concise but descriptive.", "markdownDescription": "A short title for the schema.\n\nThe title provides a human-readable name for the schema, often used\nin documentation and UI displays. It should be concise but descriptive.", - "examples": [ - "User", - "Pet", - "Order" - ] + "examples": ["User", "Pet", "Order"] }, "default": { "description": "Declares the value of the schema that the server will use if none is provided. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.\n\nThis is a Swagger 2.0 specific requirement that differs from JSON Schema. The default value must be valid according to the schema's type and constraints.", @@ -1709,10 +1337,7 @@ "name": "John", "age": 30 }, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "enum": { @@ -1721,23 +1346,9 @@ "description": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "markdownDescription": "An instance validates successfully against this keyword if its value is equal to one of the elements in this keyword's array value.", "examples": [ - [ - "option1", - "option2", - "option3" - ], - [ - "red", - "green", - "blue" - ], - [ - 1, - 2, - 3, - 4, - 5 - ] + ["option1", "option2", "option3"], + ["red", "green", "blue"], + [1, 2, 3, 4, 5] ] }, "example": { @@ -1750,10 +1361,7 @@ }, "example string value", 42, - [ - "item1", - "item2" - ] + ["item1", "item2"] ] }, "xml": { @@ -1768,9 +1376,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- File Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0 specific data type that extends the JSON Schema specification to support file operations. File schemas are used by Parameter and Response objects to indicate that the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing, image handling, and other file-based operations. They provide clear indication to API consumers that file data is expected or returned.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } | | 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nFile Schema\n-----\n\nSchema for file data types in Swagger 2.0.\n\nFile schemas represent file uploads and downloads in APIs. This is a Swagger 2.0\nspecific data type that extends the JSON Schema specification to support file\noperations. File schemas are used by Parameter and Response objects to indicate\nthat the data represents a file rather than a structured data type.\n\nFile schemas are commonly used for file upload endpoints, document processing,\nimage handling, and other file-based operations. They provide clear indication\nto API consumers that file data is expected or returned.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n| 2.0 | {@link https://swagger.io/specification/v2/#response-object Swagger 2.0 Response Object } |\n\n-----\nFields\n-----" }, @@ -1782,9 +1388,7 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate that this schema represents an ordered collection of items.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.\n\nThis property is required and must be set to \"array\" to indicate\nthat this schema represents an ordered collection of items.", - "examples": [ - "array" - ] + "examples": ["array"] }, "items": { "$ref": "#/definitions/Schema", @@ -1811,28 +1415,19 @@ "type": "number", "description": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", "markdownDescription": "An array is valid against \"maxItems\" if its length is less than or equal to this value.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", "markdownDescription": "An array is valid against \"minItems\" if its length is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "uniqueItems": { "type": "boolean", "description": "An array is valid against \"uniqueItems\" if all its elements are unique.", "markdownDescription": "An array is valid against \"uniqueItems\" if all its elements are unique.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1846,10 +1441,7 @@ ] } }, - "required": [ - "type", - "items" - ], + "required": ["type", "items"], "description": "----- Array Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms to a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific adjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs. They support validation of array length, item uniqueness, and item type constraints. The items property defines the schema that each array element must conform to.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } | | 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nSchema for array data types in Swagger 2.0.\n\nArray schemas represent ordered collections of items, where each item conforms\nto a specified schema. They are based on JSON Schema Draft 4 with Swagger-specific\nadjustments, providing comprehensive validation for array data structures.\n\nArray schemas are commonly used for lists, collections, and ordered data in APIs.\nThey support validation of array length, item uniqueness, and item type constraints.\nThe items property defines the schema that each array element must conform to.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#data-types Swagger 2.0 Data Types } |\n| 2.0 | {@link https://swagger.io/specification/v2/#schema-object Swagger 2.0 Schema Object } |\n\n-----\nFields\n-----" }, @@ -1861,9 +1453,7 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate that this schema represents structured data with named properties.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.\n\nThis property is required and must be set to \"object\" to indicate\nthat this schema represents structured data with named properties.", - "examples": [ - "object" - ] + "examples": ["object"] }, "properties": { "type": "object", @@ -1896,15 +1486,8 @@ "description": "A list of required properties. Properties marked as required being true MUST be present in the object.\n\nThis array contains the names of properties that must be present in any valid instance of this object schema. Properties not listed here are considered optional.", "markdownDescription": "A list of required properties. Properties marked as required being true\nMUST be present in the object.\n\nThis array contains the names of properties that must be present in\nany valid instance of this object schema. Properties not listed here\nare considered optional.", "examples": [ - [ - "name", - "email" - ], - [ - "id", - "type", - "createdAt" - ] + ["name", "email"], + ["id", "type", "createdAt"] ] }, "additionalProperties": { @@ -1951,19 +1534,13 @@ "type": "number", "description": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", "markdownDescription": "An object is valid against \"maxProperties\" if its number of properties is less than or equal to this value.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", "markdownDescription": "An object is valid against \"minProperties\" if its number of properties is greater than or equal to this value.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] }, "xml": { "$ref": "#/definitions/XMLObject", @@ -1997,9 +1574,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- JSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification. It can be used to reference parameters and responses that are defined at the top level for reuse. The Reference Object is a JSON Reference that uses a JSON Pointer as its value. For this specification, only canonical dereferencing is supported.\n\nJSON References enable reusability and modularity in API specifications by allowing the same definition to be referenced multiple times throughout the document. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } | | 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } | | 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n----- Fields\n-----", "markdownDescription": "-----\nJSON Reference Object\n-----\n\nA simple object to allow referencing other definitions in the specification.\nIt can be used to reference parameters and responses that are defined at the\ntop level for reuse. The Reference Object is a JSON Reference that uses a\nJSON Pointer as its value. For this specification, only canonical dereferencing\nis supported.\n\nJSON References enable reusability and modularity in API specifications by\nallowing the same definition to be referenced multiple times throughout the\ndocument. This reduces duplication and makes specifications easier to maintain.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#reference-object Swagger 2.0 Reference Object } |\n| 2.0 | {@link https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-02 JSON Reference Specification } |\n| 2.0 | {@link https://tools.ietf.org/html/rfc6901 JSON Pointer Specification } |\n\n-----\nFields\n-----" @@ -2011,83 +1586,46 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment from the path field in the Paths Object\n- For all other cases, the name corresponds to the parameter name used by the in property", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "formData" - ], + "enum": ["query", "header", "path", "formData"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\", or \"formData\".\n\n- **query**: Parameters that are appended to the URL. For example, in `/users?role=admin`, the role query parameter has the value admin.\n- **header**: Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL. This does not include the host or base path of the API.\n- **formData**: Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded or multipart/form-data is used as the content type of the request.", - "examples": [ - "query", - "path", - "header", - "formData" - ] + "examples": ["query", "path", "header", "formData"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nGFM syntax can be used for rich text representation.", - "examples": [ - "The user ID", - "Maximum number of items to return (default: 10)" - ] + "examples": ["The user ID", "Maximum number of items to return (default: 10)"] }, "required": { "type": "boolean", "description": "Determines whether this parameter is mandatory. If the parameter is in \"path\", this property is required and its value MUST be true. Otherwise, the property MAY be included and its default value is false.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter is in \"path\",\nthis property is required and its value MUST be true. Otherwise, the property\nMAY be included and its default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "type": { "type": "string", - "enum": [ - "string", - "number", - "integer", - "boolean", - "array", - "file" - ], + "enum": ["string", "number", "integer", "boolean", "array", "file"], "description": "The type of the parameter. Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\", the consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\" or both and the parameter MUST be in \"formData\".", "markdownDescription": "The type of the parameter. Since the parameter is not located at the request body,\nit is limited to simple types (that is, not an object). The value MUST be one of\n\"string\", \"number\", \"integer\", \"boolean\", \"array\" or \"file\". If type is \"file\",\nthe consumes MUST be either \"multipart/form-data\", \"application/x-www-form-urlencoded\"\nor both and the parameter MUST be in \"formData\".", - "examples": [ - "string", - "integer", - "array", - "file" - ] + "examples": ["string", "integer", "array", "file"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for either query or formData parameters and allows you to send a parameter with a name only or an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for either\nquery or formData parameters and allows you to send a parameter with a name only\nor an empty value. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -2106,135 +1644,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes", - "multi" - ], + "enum": ["csv", "ssv", "tsv", "pipes", "multi"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar\n- multi: corresponds to multiple parameter instances instead of multiple values for a single instance foo=bar&foo=baz", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the parameter that the server will use if none is provided. This value MUST conform to the defined type for this parameter.", "markdownDescription": "Declares the value of the parameter that the server will use if none is provided.\nThis value MUST conform to the defined type for this parameter.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "name", - "in", - "type" - ], + "required": ["name", "in", "type"], "description": "----- Parameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include query, header, path, and formData parameters. They have different validation rules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file) and include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object (Non-Body Parameter)\n-----\n\nDescribes a non-body parameter for an API operation. These parameters include\nquery, header, path, and formData parameters. They have different validation\nrules and properties compared to body parameters.\n\nNon-body parameters support simple types (string, number, integer, boolean, array, file)\nand include validation properties like format, pattern, minimum, maximum, etc.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#parameter-object Swagger 2.0 Parameter Object } |\n\n-----\nFields\n-----" }, @@ -2245,21 +1740,13 @@ "type": "string", "description": "The internal type of the array. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". Files and models are not allowed.", "markdownDescription": "The internal type of the array. The value MUST be one of \"string\", \"number\",\n\"integer\", \"boolean\", or \"array\". Files and models are not allowed.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2277,132 +1764,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the item that the server will use if none is provided. This value MUST conform to the defined type for the data type.", "markdownDescription": "Declares the value of the item that the server will use if none is provided.\nThis value MUST conform to the defined type for the data type.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions that are not located in \"body\".", "markdownDescription": "Items Object\n\nA limited subset of JSON-Schema's items object. It is used by parameter definitions\nthat are not located in \"body\"." }, @@ -2801,9 +2248,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. It is not expected from the documentation to necessarily cover all possible HTTP response codes because they may not be known in advance. However, it is expected from the documentation to cover a successful operation response and any known errors.", "markdownDescription": "Response Object\n\nDescribes a single response from an API Operation. A container for the expected\nresponses of an operation. The container maps a HTTP response code to the expected\nresponse. It is not expected from the documentation to necessarily cover all\npossible HTTP response codes because they may not be known in advance. However,\nit is expected from the documentation to cover a successful operation response\nand any known errors." }, @@ -2814,30 +2259,19 @@ "type": "string", "description": "A brief description of the header. GFM syntax can be used for rich text representation.", "markdownDescription": "A brief description of the header. GFM syntax can be used for rich text representation.", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "type": { "type": "string", "description": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\", \"boolean\", or \"array\". This field is required.", "markdownDescription": "The type of the object. The value MUST be one of \"string\", \"number\", \"integer\",\n\"boolean\", or \"array\".\nThis field is required.", - "examples": [ - "string", - "integer", - "array" - ] + "examples": ["string", "integer", "array"] }, "format": { "type": "string", "description": "The extending format for the previously mentioned type. See Data Type Formats for further details.", "markdownDescription": "The extending format for the previously mentioned type. See Data Type Formats\nfor further details.", - "examples": [ - "int32", - "date", - "email" - ] + "examples": ["int32", "date", "email"] }, "items": { "$ref": "#/definitions/Items", @@ -2855,132 +2289,92 @@ }, "collectionFormat": { "type": "string", - "enum": [ - "csv", - "ssv", - "tsv", - "pipes" - ], + "enum": ["csv", "ssv", "tsv", "pipes"], "description": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", "markdownDescription": "Determines the format of the array if type array is used. Possible values are:\n- csv: comma separated values foo,bar\n- ssv: space separated values foo bar\n- tsv: tab separated values foo\\tbar\n- pipes: pipe separated values foo|bar", - "examples": [ - "multi" - ], + "examples": ["multi"], "default": "csv" }, "default": { "description": "Declares the value of the header that the server will use if none is provided. This value MUST conform to the defined type for the header.", "markdownDescription": "Declares the value of the header that the server will use if none is provided.\nThis value MUST conform to the defined type for the header.", - "examples": [ - "defaultValue", - 10 - ] + "examples": ["defaultValue", 10] }, "maximum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - 100 - ] + "examples": [100] }, "exclusiveMaximum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.2", - "examples": [ - false - ] + "examples": [false] }, "minimum": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - 0 - ] + "examples": [0] }, "exclusiveMinimum": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.3", - "examples": [ - false - ] + "examples": [false] }, "maxLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.1", - "examples": [ - 100 - ] + "examples": [100] }, "minLength": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.2", - "examples": [ - 1 - ] + "examples": [1] }, "pattern": { "type": "string", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.2.3", - "examples": [ - "^[a-zA-Z0-9]+$" - ] + "examples": ["^[a-zA-Z0-9]+$"] }, "maxItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.2", - "examples": [ - 10 - ] + "examples": [10] }, "minItems": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.3", - "examples": [ - 1 - ] + "examples": [1] }, "uniqueItems": { "type": "boolean", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.3.4", - "examples": [ - true - ] + "examples": [true] }, "enum": { "type": "array", "items": {}, "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.5.1", - "examples": [ - [ - "option1", - "option2", - "option3" - ] - ] + "examples": [["option1", "option2", "option3"]] }, "multipleOf": { "type": "number", "description": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", "markdownDescription": "See https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-5.1.1", - "examples": [ - 2 - ] + "examples": [2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with the response. The name is used to refer to the respective header definition. The value of the header is of type string.", "markdownDescription": "Header Object\n\nDescribes a single header parameter. A list of all headers that are sent with\nthe response. The name is used to refer to the respective header definition.\nThe value of the header is of type string." }, @@ -3064,65 +2458,36 @@ "properties": { "type": { "type": "string", - "enum": [ - "basic", - "apiKey", - "oauth2" - ], + "enum": ["basic", "apiKey", "oauth2"], "description": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\". This field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", "markdownDescription": "The type of the security scheme. Valid values are \"basic\", \"apiKey\" or \"oauth2\".\nThis field is required.\n\n- **basic**: Basic HTTP authentication\n- **apiKey**: API key authentication (header or query parameter)\n- **oauth2**: OAuth 2.0 authentication", - "examples": [ - "apiKey", - "oauth2", - "basic" - ] + "examples": ["apiKey", "oauth2", "basic"] }, "description": { "type": "string", "description": "A short description for security scheme. GFM syntax can be used for rich text representation.", "markdownDescription": "A short description for security scheme. GFM syntax can be used for rich text representation.", - "examples": [ - "API key for authentication", - "OAuth 2.0 with authorization code flow" - ] + "examples": ["API key for authentication", "OAuth 2.0 with authorization code flow"] }, "name": { "type": "string", "description": "The name of the header or query parameter to be used. This field is required for apiKey type and applies to apiKey type only.", "markdownDescription": "The name of the header or query parameter to be used. This field is required\nfor apiKey type and applies to apiKey type only.", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header" - ], + "enum": ["query", "header"], "description": "The location of the API key. This field is required for apiKey type and applies to apiKey type only. Valid values are \"query\" or \"header\".", "markdownDescription": "The location of the API key. This field is required for apiKey type and\napplies to apiKey type only. Valid values are \"query\" or \"header\".", - "examples": [ - "header", - "query" - ] + "examples": ["header", "query"] }, "flow": { "type": "string", - "enum": [ - "implicit", - "password", - "application", - "accessCode" - ], + "enum": ["implicit", "password", "application", "accessCode"], "description": "The flow used by the OAuth2 security scheme. This field is required for oauth2 type and applies to oauth2 type only. Valid values are \"implicit\", \"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", "markdownDescription": "The flow used by the OAuth2 security scheme. This field is required for\noauth2 type and applies to oauth2 type only. Valid values are \"implicit\",\n\"password\", \"application\" or \"accessCode\".\n\n- **implicit**: Implicit flow\n- **password**: Resource owner password credentials flow\n- **application**: Client credentials flow\n- **accessCode**: Authorization code flow", - "examples": [ - "accessCode", - "implicit", - "password" - ] + "examples": ["accessCode", "implicit", "password"] }, "authorizationUrl": { "type": "string", @@ -3137,10 +2502,7 @@ "type": "string", "description": "The token URL to be used for this flow. This SHOULD be in the form of a URL. This field is required for oauth2 type and applies to oauth2 type only.", "markdownDescription": "The token URL to be used for this flow. This SHOULD be in the form of a URL.\nThis field is required for oauth2 type and applies to oauth2 type only.", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "scopes": { "$ref": "#/definitions/Scopes", @@ -3157,9 +2519,7 @@ ] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).", "markdownDescription": "Security Scheme Object\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare basic authentication, an API key (either as a header or as a query parameter)\nand OAuth2's common flows (implicit, password, application and access code)." }, @@ -3196,10 +2556,7 @@ "api_key": [] }, { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] }, @@ -3213,12 +2570,7 @@ "type": "string", "description": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and must be unique within the entire specification. It should be descriptive and follow a consistent naming convention.", "markdownDescription": "The name of the tag. This field is required and MUST be unique.\n\nThe tag name is used to reference this tag in Operation objects and\nmust be unique within the entire specification. It should be descriptive\nand follow a consistent naming convention.", - "examples": [ - "users", - "pets", - "authentication", - "reports" - ] + "examples": ["users", "pets", "authentication", "reports"] }, "description": { "type": "string", @@ -3246,11 +2598,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations by resources or any other qualifier. 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.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nA grouping tag for operations. Tags can be used for logical grouping of operations\nby resources or any other qualifier. The order of the tags can be used to reflect\non their order by the parsing tools. Not all tags that are used by the Operation\nObject must be declared. The tags that are not declared may be organized randomly\nor based on the tools' logic. Each tag name in the list MUST be unique.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 2.0 | {@link https://swagger.io/specification/v2/#tag-object Swagger 2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/callback.json b/schemas/3.0/components/callback.json index 7260257..78f39a3 100644 --- a/schemas/3.0/components/callback.json +++ b/schemas/3.0/components/callback.json @@ -12,13 +12,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -74,10 +68,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -110,11 +101,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -125,10 +112,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -143,10 +127,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -174,16 +155,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -194,28 +169,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -228,11 +194,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -245,9 +207,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1592,10 +1552,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1616,9 +1573,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1633,26 +1588,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1664,9 +1608,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1698,17 +1640,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -1890,24 +1828,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -1932,10 +1859,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2026,9 +1950,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2046,10 +1968,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2070,9 +1989,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2083,24 +2000,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2111,64 +2020,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2197,19 +2080,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2229,10 +2106,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2275,10 +2149,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2329,15 +2200,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2349,56 +2215,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2408,34 +2255,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2464,42 +2299,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2510,46 +2332,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2563,54 +2370,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2620,36 +2410,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2678,61 +2454,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2744,54 +2500,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2801,36 +2540,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2859,61 +2584,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2925,45 +2630,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -2972,29 +2663,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3023,15 +2705,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3043,40 +2721,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3084,15 +2748,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3105,24 +2762,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3130,18 +2775,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3170,9 +2811,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3192,33 +2831,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3230,18 +2859,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3312,18 +2936,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3352,19 +2972,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3396,15 +3011,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3460,24 +3067,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3488,11 +3087,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3513,9 +3108,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3527,10 +3120,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3567,33 +3157,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3622,19 +3201,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3650,9 +3224,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3718,10 +3290,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3770,9 +3339,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3865,11 +3432,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -3897,36 +3460,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -3939,55 +3488,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4012,10 +3544,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4068,10 +3597,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4094,15 +3620,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4544,9 +4066,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4566,10 +4086,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4599,10 +4116,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -4881,71 +4395,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -4964,14 +4448,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5051,19 +4531,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5083,9 +4557,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5096,20 +4568,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5123,11 +4588,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/example.json b/schemas/3.0/components/example.json index 147a584..eac6349 100644 --- a/schemas/3.0/components/example.json +++ b/schemas/3.0/components/example.json @@ -6,10 +6,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -49,13 +46,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -111,10 +102,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -147,11 +135,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -162,10 +146,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -180,10 +161,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -211,16 +189,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -231,28 +203,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -265,11 +228,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -282,9 +241,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1629,10 +1586,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1653,9 +1607,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1670,26 +1622,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1701,9 +1642,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1735,17 +1674,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -1927,24 +1862,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -1969,10 +1893,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2063,9 +1984,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2083,10 +2002,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2107,9 +2023,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2120,24 +2034,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2148,64 +2054,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2234,19 +2114,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2266,10 +2140,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2312,10 +2183,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2366,15 +2234,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2386,56 +2249,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2445,34 +2289,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2501,42 +2333,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2547,46 +2366,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2600,54 +2404,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2657,36 +2444,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2715,61 +2488,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2781,54 +2534,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2838,36 +2574,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2896,61 +2618,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2962,45 +2664,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -3009,29 +2697,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3060,15 +2739,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3080,40 +2755,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3121,15 +2782,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3142,24 +2796,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3167,18 +2809,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3207,9 +2845,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3229,33 +2865,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3267,18 +2893,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3349,18 +2970,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3389,19 +3006,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3433,15 +3045,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3497,24 +3101,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3525,11 +3121,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3550,9 +3142,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3564,10 +3154,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3604,33 +3191,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3659,19 +3235,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3687,9 +3258,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3755,10 +3324,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3807,9 +3373,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3902,11 +3466,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -3934,36 +3494,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -3976,55 +3522,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4049,10 +3578,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4105,10 +3631,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4131,15 +3654,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4581,9 +4100,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4603,10 +4120,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4636,10 +4150,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -4918,71 +4429,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -5001,14 +4482,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5088,19 +4565,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5120,9 +4591,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5133,20 +4602,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5160,11 +4622,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/header.json b/schemas/3.0/components/header.json index 9aa8a87..32678d9 100644 --- a/schemas/3.0/components/header.json +++ b/schemas/3.0/components/header.json @@ -6,55 +6,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -79,10 +62,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -133,13 +113,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -195,10 +169,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -231,11 +202,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -246,10 +213,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -264,10 +228,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -295,16 +256,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -315,28 +270,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -349,11 +295,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -366,9 +308,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1713,10 +1653,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1737,9 +1674,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1754,26 +1689,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1785,9 +1709,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1819,17 +1741,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -2011,24 +1929,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -2053,10 +1960,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2147,9 +2051,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2167,10 +2069,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2191,9 +2090,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2204,24 +2101,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2232,64 +2121,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2318,19 +2181,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2350,10 +2207,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2396,10 +2250,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2450,15 +2301,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2470,56 +2316,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2529,34 +2356,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2585,42 +2400,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2631,46 +2433,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2684,54 +2471,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2741,36 +2511,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2799,61 +2555,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2865,54 +2601,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2922,36 +2641,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2980,61 +2685,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3046,45 +2731,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -3093,29 +2764,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3144,15 +2806,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3164,40 +2822,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3205,15 +2849,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3226,24 +2863,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3251,18 +2876,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3291,9 +2912,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3313,33 +2932,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3351,18 +2960,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3433,18 +3037,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3473,19 +3073,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3517,15 +3112,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3581,24 +3168,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3609,11 +3188,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3634,9 +3209,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3648,10 +3221,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3688,33 +3258,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3743,19 +3302,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3771,9 +3325,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3839,10 +3391,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3891,9 +3440,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3986,11 +3533,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -4018,36 +3561,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -4060,55 +3589,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4133,10 +3645,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4189,10 +3698,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4215,15 +3721,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4665,9 +4167,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4687,10 +4187,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4720,10 +4217,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -5002,71 +4496,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -5085,14 +4549,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5172,19 +4632,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5204,9 +4658,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5217,20 +4669,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5244,11 +4689,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/link.json b/schemas/3.0/components/link.json index 824ff80..acef729 100644 --- a/schemas/3.0/components/link.json +++ b/schemas/3.0/components/link.json @@ -15,10 +15,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -48,10 +45,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -72,13 +66,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -134,10 +122,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -170,11 +155,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -185,10 +166,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -203,10 +181,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -234,16 +209,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -254,28 +223,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -288,11 +248,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -305,9 +261,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1652,10 +1606,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1676,9 +1627,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1693,26 +1642,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1724,9 +1662,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1758,17 +1694,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -1950,24 +1882,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -1992,10 +1913,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2086,9 +2004,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2106,10 +2022,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2130,9 +2043,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2143,24 +2054,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2171,64 +2074,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2257,19 +2134,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2289,10 +2160,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2335,10 +2203,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2389,15 +2254,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2409,56 +2269,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2468,34 +2309,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2524,42 +2353,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2570,46 +2386,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2623,54 +2424,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2680,36 +2464,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2738,61 +2508,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2804,54 +2554,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2861,36 +2594,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2919,61 +2638,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2985,45 +2684,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -3032,29 +2717,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3083,15 +2759,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3103,40 +2775,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3144,15 +2802,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3165,24 +2816,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3190,18 +2829,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3230,9 +2865,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3252,33 +2885,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3290,18 +2913,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3372,18 +2990,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3412,19 +3026,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3456,15 +3065,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3520,24 +3121,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3548,11 +3141,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3573,9 +3162,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3587,10 +3174,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3627,33 +3211,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3682,19 +3255,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3710,9 +3278,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3778,10 +3344,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3830,9 +3393,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3925,11 +3486,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -3957,36 +3514,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -3999,55 +3542,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4072,10 +3598,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4128,10 +3651,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4154,15 +3674,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4604,9 +4120,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4626,10 +4140,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4659,10 +4170,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -4941,71 +4449,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -5024,14 +4502,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5111,19 +4585,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5143,9 +4611,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5156,20 +4622,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5183,11 +4642,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/parameter.json b/schemas/3.0/components/parameter.json index e00c8b3..1b01962 100644 --- a/schemas/3.0/components/parameter.json +++ b/schemas/3.0/components/parameter.json @@ -6,64 +6,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -92,19 +66,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -124,10 +92,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -170,10 +135,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----", "definitions": { @@ -182,13 +144,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -244,10 +200,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -280,11 +233,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -295,10 +244,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -313,10 +259,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -344,16 +287,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -364,28 +301,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -398,11 +326,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -415,9 +339,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1762,10 +1684,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1786,9 +1705,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1803,26 +1720,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1834,9 +1740,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1868,17 +1772,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -2060,24 +1960,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -2102,10 +1991,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2196,9 +2082,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2216,10 +2100,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2240,9 +2121,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2253,24 +2132,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2281,64 +2152,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2367,19 +2212,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2399,10 +2238,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2445,10 +2281,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2499,15 +2332,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2519,56 +2347,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2578,34 +2387,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2634,42 +2431,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2680,46 +2464,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2733,54 +2502,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2790,36 +2542,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2848,61 +2586,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2914,54 +2632,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2971,36 +2672,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3029,61 +2716,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3095,45 +2762,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -3142,29 +2795,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3193,15 +2837,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3213,40 +2853,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3254,15 +2880,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3275,24 +2894,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3300,18 +2907,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3340,9 +2943,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3362,33 +2963,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3400,18 +2991,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3482,18 +3068,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3522,19 +3104,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3566,15 +3143,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3630,24 +3199,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3658,11 +3219,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3683,9 +3240,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3697,10 +3252,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3737,33 +3289,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3792,19 +3333,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3820,9 +3356,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3888,10 +3422,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3940,9 +3471,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -4035,11 +3564,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -4067,36 +3592,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -4109,55 +3620,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4182,10 +3676,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4238,10 +3729,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4264,15 +3752,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4714,9 +4198,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4736,10 +4218,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4769,10 +4248,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -5051,71 +4527,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -5134,14 +4580,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5221,19 +4663,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5253,9 +4689,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5266,20 +4700,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5293,11 +4720,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/pathitem.json b/schemas/3.0/components/pathitem.json new file mode 100644 index 0000000..a049977 --- /dev/null +++ b/schemas/3.0/components/pathitem.json @@ -0,0 +1,4780 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "anyOf": [ + { + "type": "object", + "properties": { + "$ref": { + "type": "string", + "description": "Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - $ref } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - $ref } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - $ref } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - $ref } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - $ref } |", + "markdownDescription": "Allows for an external definition of this path item. The referenced structure\nMUST be in the format of a Path Item Object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - $ref } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - $ref } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - $ref } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - $ref } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - $ref } |" + }, + "summary": { + "type": "string", + "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", + "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", + "examples": ["User management operations"] + }, + "description": { + "type": "string", + "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", + "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", + "examples": ["Operations for managing users in the system"] + }, + "get": { + "$ref": "#/definitions/Operation", + "description": "A definition of a GET operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - get } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - get } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - get } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - get } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - get } |", + "markdownDescription": "A definition of a GET operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - get } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - get } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - get } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - get } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - get } |", + "examples": [ + { + "summary": "Get users", + "responses": { + "200": { + "description": "Success" + } + } + } + ] + }, + "put": { + "$ref": "#/definitions/Operation", + "description": "A definition of a PUT operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - put } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - put } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - put } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - put } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - put } |", + "markdownDescription": "A definition of a PUT operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - put } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - put } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - put } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - put } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - put } |", + "examples": [ + { + "summary": "Update user", + "responses": { + "200": { + "description": "Success" + } + } + } + ] + }, + "post": { + "$ref": "#/definitions/Operation", + "description": "A definition of a POST operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - post } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - post } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - post } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - post } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - post } |", + "markdownDescription": "A definition of a POST operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - post } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - post } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - post } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - post } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - post } |", + "examples": [ + { + "summary": "Create user", + "responses": { + "201": { + "description": "Created" + } + } + } + ] + }, + "delete": { + "$ref": "#/definitions/Operation", + "description": "A definition of a DELETE operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - delete } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - delete } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - delete } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - delete } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - delete } |", + "markdownDescription": "A definition of a DELETE operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - delete } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - delete } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - delete } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - delete } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - delete } |", + "examples": [ + { + "summary": "Delete user", + "responses": { + "204": { + "description": "No Content" + } + } + } + ] + }, + "options": { + "$ref": "#/definitions/Operation", + "description": "A definition of an OPTIONS operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - options } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - options } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - options } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - options } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - options } |", + "markdownDescription": "A definition of an OPTIONS operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - options } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - options } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - options } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - options } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - options } |", + "examples": [ + { + "summary": "Get options", + "responses": { + "200": { + "description": "Options" + } + } + } + ] + }, + "head": { + "$ref": "#/definitions/Operation", + "description": "A definition of a HEAD operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - head } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - head } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - head } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - head } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - head } |", + "markdownDescription": "A definition of a HEAD operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - head } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - head } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - head } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - head } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - head } |", + "examples": [ + { + "summary": "Check if resource exists", + "responses": { + "200": { + "description": "Exists" + } + } + } + ] + }, + "patch": { + "$ref": "#/definitions/Operation", + "description": "A definition of a PATCH operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - patch } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - patch } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - patch } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - patch } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - patch } |", + "markdownDescription": "A definition of a PATCH operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - patch } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - patch } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - patch } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - patch } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - patch } |", + "examples": [ + { + "summary": "Partially update user", + "responses": { + "200": { + "description": "Success" + } + } + } + ] + }, + "trace": { + "$ref": "#/definitions/Operation", + "description": "A definition of a TRACE operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - trace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - trace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - trace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - trace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - trace } |", + "markdownDescription": "A definition of a TRACE operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - trace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - trace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - trace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - trace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - trace } |", + "examples": [ + { + "summary": "Trace request", + "responses": { + "200": { + "description": "Success" + } + } + } + ] + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "An alternative server array to service all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - servers } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - servers } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - servers } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - servers } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - servers } |", + "markdownDescription": "An alternative server array to service all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - servers } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - servers } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - servers } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - servers } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - servers } |", + "examples": [ + [ + { + "url": "https://api.example.com/v1" + } + ] + ] + }, + "parameters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/definitions/Parameter" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - parameters } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - parameters } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - parameters } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - parameters } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - parameters } |", + "markdownDescription": "A list of parameters that are applicable for all the operations described\nunder this path. These parameters can be overridden at the operation level,\nbut cannot be removed there. The list MUST NOT include duplicated parameters.\nA unique parameter is defined by a combination of a name and location.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - parameters } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - parameters } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - parameters } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - parameters } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - parameters } |", + "examples": [ + [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "integer" + } + } + ] + ] + } + } + }, + { + "$ref": "#/definitions/Reference" + } + ], + "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints.\n\nThe Path Item Object describes the operations available on a single path. It can contain a summary and description that apply to all operations on the path, as well as individual operation definitions for each HTTP method.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path.\nA Path Item MAY be empty, due to ACL constraints.\n\nThe Path Item Object describes the operations available on a single path. It can\ncontain a summary and description that apply to all operations on the path, as well\nas individual operation definitions for each HTTP method.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item } |\n\n-----\nFields\n-----", + "definitions": { + "Specification": { + "type": "object", + "properties": { + "openapi": { + "type": "string", + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], + "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", + "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" + }, + "info": { + "$ref": "#/definitions/Info", + "description": "Provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - info } |", + "markdownDescription": "Provides metadata about the API. The metadata can be used by the clients\nif needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - info } |" + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of \"/\".\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - servers } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - servers } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - servers } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - servers } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - servers } |", + "markdownDescription": "An array of Server Objects, which provide connectivity information to a target server.\nIf the servers property is not provided, or is an empty array, the default value\nwould be a Server Object with a url value of \"/\".\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - servers } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - servers } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - servers } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - servers } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - servers } |", + "examples": [ + [ + { + "url": "https://api.example.com/v1", + "description": "Production server" + } + ], + [ + { + "url": "https://staging-api.example.com/v1", + "description": "Staging server" + } + ] + ] + }, + "paths": { + "$ref": "#/definitions/Paths", + "description": "The available paths and operations for the API. This is the root of the Path Item Object. It does not define a path or a basePath, they are defined in the Paths Object. A relative path to an individual endpoint. The field name MUST begin with a slash. The path is appended to the basePath in order to construct the full URL. Path templating is allowed.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - paths } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - paths } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - paths } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - paths } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - paths } |", + "markdownDescription": "The available paths and operations for the API. This is the root of the\nPath Item Object. It does not define a path or a basePath, they are defined\nin the Paths Object. A relative path to an individual endpoint. The field\nname MUST begin with a slash. The path is appended to the basePath in order\nto construct the full URL. Path templating is allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - paths } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - paths } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - paths } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - paths } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - paths } |" + }, + "components": { + "$ref": "#/definitions/Components", + "description": "An element to hold various schemas for the specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - components } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - components } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - components } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - components } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - components } |", + "markdownDescription": "An element to hold various schemas for the specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - components } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - components } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - components } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - components } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - components } |" + }, + "security": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRequirement" + }, + "description": "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.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - security } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - security } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - security } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - security } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - security } |", + "markdownDescription": "A declaration of which security mechanisms can be used across the API.\nThe list of values includes alternative security requirement objects that can be used.\nOnly one of the security requirement objects need to be satisfied to authorize a request.\nIndividual operations can override this definition.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - security } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - security } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - security } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - security } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - security } |", + "examples": [ + [ + { + "api_key": [] + } + ], + [ + { + "oauth2": ["read", "write"] + } + ] + ] + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + }, + "description": "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.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - tags } |", + "markdownDescription": "A list of tags used by the specification with additional metadata.\nThe order of the tags can be used to reflect on their order by the\nparsing tools. Not all tags that are used by the Operation Object must\nbe declared. The tags that are not declared may be organized randomly\nor based on the tools' logic. Each tag name in the list MUST be unique.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - tags } |", + "examples": [ + [ + { + "name": "users", + "description": "User management" + } + ] + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - externalDocs } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - externalDocs } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - externalDocs } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - externalDocs } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - externalDocs } |", + "markdownDescription": "Additional external documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - externalDocs } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - externalDocs } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - externalDocs } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - externalDocs } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - externalDocs } |", + "examples": [ + { + "description": "Find out more about our API", + "url": "https://example.com/docs" + } + ] + } + }, + "required": ["info", "openapi", "paths"], + "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" + }, + "Info": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", + "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", + "examples": ["Sample Pet Store App", "My API"] + }, + "description": { + "type": "string", + "description": "A short description of the application. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - description } |", + "markdownDescription": "A short description of the application. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - description } |", + "examples": [ + "This is a sample server for a pet store.", + "A comprehensive API for managing user data" + ] + }, + "termsOfService": { + "type": "string", + "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", + "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", + "examples": ["http://example.com/terms/", "https://example.com/terms"] + }, + "contact": { + "$ref": "#/definitions/Contact", + "description": "The contact information for the exposed API.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } |", + "markdownDescription": "The contact information for the exposed API.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - contact } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - contact } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - contact } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - contact } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - contact } |", + "examples": [ + { + "name": "API Support", + "email": "support@example.com" + } + ] + }, + "license": { + "$ref": "#/definitions/License", + "description": "The license information for the exposed API.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } |", + "markdownDescription": "The license information for the exposed API.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - license } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - license } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - license } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - license } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - license } |", + "examples": [ + { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + } + ] + }, + "version": { + "type": "string", + "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", + "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", + "examples": ["1.0.1", "2.0.0"] + } + }, + "required": ["title", "version"], + "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" + }, + "Contact": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", + "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", + "examples": ["API Support", "John Doe"] + }, + "url": { + "type": "string", + "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", + "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", + "examples": ["http://www.example.com/support", "https://example.com/contact"] + }, + "email": { + "type": "string", + "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", + "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", + "examples": ["support@example.com", "contact@example.com"] + } + }, + "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can\ninclude the name, URL, and email address of the contact person or organization.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n-----\nFields\n-----" + }, + "License": { + "type": "object", + "properties": { + "name": { + "$ref": "#/definitions/LicenseName", + "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", + "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] + }, + "url": { + "$ref": "#/definitions/LicenseURL", + "description": "A URL to the license used for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } |", + "markdownDescription": "A URL to the license used for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - url } |", + "examples": [ + "https://opensource.org/license/mit/", + "http://www.apache.org/licenses/LICENSE-2.0.html", + "https://example.com/licenses/proprietary-1.0" + ] + } + }, + "required": ["name"], + "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" + }, + "LicenseName": { + "anyOf": [ + { + "$ref": "#/definitions/KnownLicenseNames" + }, + { + "type": "string" + } + ], + "description": "Open enum of SPDX license names. Suggests all known license names, but also accepts custom strings.\n\nThe SPDX License List is sourced from the spdx-license-list npm package Imported here as const to provide richer types for the License type.", + "markdownDescription": "Open enum of SPDX license names.\nSuggests all known license names, but also accepts custom strings.\n\nThe SPDX License List is sourced from the spdx-license-list npm package\nImported here as const to provide richer types for the License type." + }, + "KnownLicenseNames": { + "type": "string", + "enum": [ + "DSDP License", + "NIST Public Domain Notice", + "Creative Commons Attribution Non Commercial Share Alike 2.0 Generic", + "Norwegian Licence for Open Government Data (NLOD) 1.0", + "Red Hat eCos Public License v1.1", + "GNU Free Documentation License v1.3 only - no invariants", + "Ricoh Source Code Public License", + "ASWF Digital Assets License 1.1", + "eCos license version 2.0", + "Good Luck With That Public License", + "Info-ZIP License", + "LaTeX Project Public License v1.3c", + "zlib/libpng License with Acknowledgement", + "Checkmk License", + "Open LDAP Public License v2.8", + "Common Vulnerability Enumeration ToU License", + "The MirOS Licence", + "The Parity Public License 6.0.0", + "Creative Commons Attribution Share Alike 2.1 Japan", + "Inno Setup License", + "IBM Public License v1.0", + "Spencer License 86", + "Japan Network Information Center License", + "OpenVision License", + "SGP4 Permission Notice", + "Mozilla Public License 1.1", + "BSD 3-Clause Clear License", + "AML glslang variant License", + "Vim License", + "Community Specification License 1.0", + "Open Software License 3.0", + "CrystalStacker License", + "Mozilla Public License 1.0", + "Open LDAP Public License v1.2", + "Sendmail License 8.23", + "CMU Mach License", + "XPP License", + "GNU General Public License v2.0 w/Bison exception", + "Educational Community License v1.0", + "Plexus Classworlds License", + "Elastic License 2.0", + "Common Public License 1.0", + "GNU Free Documentation License v1.2 only - no invariants", + "Open Public License v1.0", + "Creative Commons Attribution Share Alike 4.0 International", + "Amazon Digital Services License", + "SGI Free Software License B v1.1", + "XFree86 License 1.1", + "Latex2e with translated notice permission", + "IPA Font License", + "psutils License", + "Creative Commons Attribution Non Commercial No Derivatives 3.0 Unported", + "FSF Unlimited License (with License Retention)", + "SSLeay License - standalone", + "MMIXware License", + "Graphics Gems License", + "HPND with US Government export control warning and acknowledgment", + "Creative Commons Attribution Non Commercial 2.0 Generic", + "Open LDAP Public License v1.3", + "GNU Lesser General Public License v2.1 only", + "Norwegian Licence for Open Government Data (NLOD) 2.0", + "BSD 2-Clause \"Simplified\" License", + "mailprio License", + "Creative Commons Attribution Share Alike 3.0 Unported", + "Noweb License", + "Soundex License", + "CeCILL Free Software License Agreement v1.0", + "Aladdin Free Public License", + "SSH OpenSSH license", + "BSD with Attribution and HPND disclaimer", + "Creative Commons Attribution Non Commercial Share Alike 2.0 England and Wales", + "Kazlib License", + "Ubuntu Font Licence v1.0", + "SGI OpenGL License", + "Rdisc License", + "HPND sell variant with MIT disclaimer", + "Lesser General Public License For Linguistic Resources", + "OAR License", + "HTML Tidy License", + "Academy of Motion Picture Arts and Sciences BSD", + "Netizen Open Source License", + "fwlw License", + "w3m License", + "Latex2e License", + "Open Use of Data Agreement v1.0", + "mplus Font License", + "Historical Permission Notice and Disclaimer - Intel variant", + "Peer Production License", + "SIL Open Font License 1.1 with Reserved Font Name", + "Eclipse Public License 1.0", + "Historical Permission Notice and Disclaimer - University of California, US export warning", + "Creative Commons Attribution 3.0 Germany", + "SNIA Public License 1.1", + "Barr License", + "Open LDAP Public License v2.1", + "Creative Commons Attribution No Derivatives 4.0 International", + "softSurfer License", + "GNU Lesser General Public License v2.1 or later", + "SIL Open Font License 1.0", + "BSD 3-Clause Flex variant", + "psfrag License", + "BSD 1-Clause License", + "BSD 3-Clause No Military License", + "Cube License", + "LaTeX Project Public License v1.2", + "Open LDAP Public License 2.2.2", + "Text-Tabs+Wrap License", + "Creative Commons Attribution 3.0 Unported", + "BSD 3-Clause Open MPI variant", + "Creative Commons Attribution Non Commercial No Derivatives 3.0 IGO", + "Zope Public License 2.1", + "Creative Commons Zero v1.0 Universal", + "Netscape Public License v1.0", + "CeCILL Free Software License Agreement v2.0", + "WWL License", + "Nethack General Public License", + "FSF All Permissive License", + "Any OSI License", + "mpich2 License", + "EU DataGrid Software License", + "Sleepycat License", + "Academic Free License v3.0", + "Arphic Public License", + "BSD-4-Clause (University of California-Specific)", + "David M. Gay dtoa License", + "Unicode License Agreement - Data Files and Software (2015)", + "TCP Wrappers License", + "MIT No Attribution", + "SugarCRM Public License v1.1.3", + "iMatix Standard Function Library Agreement", + "Creative Commons Attribution 3.0 Austria", + "Adobe Systems Incorporated Source Code License Agreement", + "Common Lisp LOOP License", + "MIT testregex Variant", + "eGenix.com Public License 1.1.0", + "Gnome GCR Documentation License", + "Attribution Assurance License", + "Cryptographic Autonomy License 1.0", + "PHP License v3.0", + "hdparm License", + "OpenPBS v2.3 Software License", + "Data licence Germany – attribution – version 2.0", + "GNU Free Documentation License v1.3 or later", + "CERN Open Hardware Licence v1.2", + "MIT License", + "XSkat License", + "Gutmann License", + "wxWindows Library License", + "Creative Commons Attribution Non Commercial Share Alike 2.5 Generic", + "Open Data Commons Public Domain Dedication & License 1.0", + "The Unlicense", + "CUA Office Public License v1.0", + "NCL Source Code License", + "GNU Free Documentation License v1.1 or later - invariants", + "CeCILL Free Software License Agreement v2.1", + "PolyForm Small Business License 1.0.0", + "Hewlett-Packard 1986 License", + "HPND with US Government export control warning", + "X11 swapped final paragraphs", + "Solderpad Hardware License v0.5", + "Systemics BSD variant license", + "Community Data License Agreement Sharing 1.0", + "GNU Free Documentation License v1.1 or later", + "Newsletr License", + "TMate Open Source License", + "EPICS Open License", + "Sax Public Domain Notice", + "MIT Festival Variant", + "GNU Library General Public License v2 or later", + "Q Public License 1.0", + "SSH short notice", + "Open Government Licence v1.0", + "GNU General Public License v2.0 only", + "GNU General Public License v3.0 w/GCC Runtime Library exception", + "Educational Community License v2.0", + "Computer Associates Trusted Open Source License 1.1", + "Cornell Lossless JPEG License", + "DOC License", + "RSA Message-Digest License", + "OCLC Research Public License 2.0", + "GNU Affero General Public License v3.0 only", + "Open LDAP Public License v2.5", + "Creative Commons Attribution Share Alike 3.0 Germany", + "Artistic License 1.0 (Perl)", + "Creative Commons Attribution Non Commercial No Derivatives 4.0 International", + "BSD 3-Clause No Nuclear License 2014", + "Martin Birgmeier License", + "European Union Public License 1.0", + "McPhee Slideshow License", + "Creative Commons Attribution Non Commercial No Derivatives 1.0 Generic", + "Blue Oak Model License 1.0.0", + "Open Data Commons Attribution License v1.0", + "Copyfree Open Innovation License", + "Bitstream Vera Font License", + "JPL Image Use Policy", + "enna License", + "BSD-Inferno-Nettverk", + "Common Development and Distribution License 1.1", + "FSF Unlimited License (With License Retention and Warranty Disclaimer)", + "GNU Free Documentation License v1.2 only - invariants", + "Eiffel Forum License v1.0", + "Entessa Public License v1.0", + "3dfx Glide License", + "Creative Commons Attribution Non Commercial 3.0 Germany", + "Artistic License 1.0 w/clause 8", + "W3C Software Notice and License (1998-07-20)", + "Historical Permission Notice and Disclaimer - merchantability variant", + "Motosoto License", + "Open LDAP Public License v1.1", + "Hewlett-Packard 1989 License", + "IEC Code Components End-user licence agreement", + "Non-Commercial Government Licence", + "Creative Commons Attribution 3.0 IGO", + "BSD Source Code Attribution", + "GNU Free Documentation License v1.1 only - no invariants", + "W3C Software Notice and License (2002-12-31)", + "magaz License", + "libutil David Nugent License", + "Academic Free License v2.1", + "Nara Institute of Science and Technology License (2003)", + "DocBook XML License", + "Licence Libre du Québec – Réciprocité forte version 1.1", + "feh License", + "Michigan/Merit Networks License", + "Creative Commons Attribution Non Commercial 3.0 Unported", + "GNU General Public License v1.0 only", + "NTP License", + "Frameworx Open License 1.0", + "BSD 2-Clause NetBSD License", + "Historical Permission Notice and Disclaimer - sell variant", + "Creative Commons Attribution 1.0 Generic", + "Adaptive Public License 1.0", + "Do What The F*ck You Want To Public License", + "Fuzzy Bitmap License", + "Clarified Artistic License", + "SunPro License", + "Vovida Software License v1.0", + "Creative Commons Attribution Non Commercial Share Alike 3.0 IGO", + "Net Boolean Public License v1", + "Open Publication License v1.0", + "Creative Commons Attribution Non Commercial No Derivatives 2.0 Generic", + "Lawrence Berkeley National Labs BSD variant license", + "Ruby License", + "Fair License", + "Enlightenment License (e16)", + "Taiwan Open Government Data License, version 1.0", + "United Kingdom Open Parliament Licence v3.0", + "Mozilla Public License 2.0", + "DocBook Stylesheet License", + "THOR Public License 1.0", + "TAPR Open Hardware License v1.0", + "UnixCrypt License", + "FreeBSD Documentation License", + "CMU Mach - no notices-in-documentation variant", + "Creative Commons Attribution 3.0 Australia", + "Zimbra Public License v1.4", + "BSD 3-Clause \"New\" or \"Revised\" License", + "lsof License", + "FreeImage Public License v1.0", + "Open LDAP Public License v2.0 (or possibly 2.0A and 2.0B)", + "Apple Public Source License 1.2", + "Apple Public Source License 1.0", + "Creative Commons Attribution-NonCommercial-ShareAlike 2.0 France", + "Deutsche Freie Software Lizenz", + "pnmstitch License", + "Creative Commons Attribution Share Alike 2.0 England and Wales", + "CERN Open Hardware Licence Version 2 - Weakly Reciprocal", + "Lucent Public License v1.02", + "CNRI Jython License", + "BSD 2-Clause - first lines requirement", + "Boost Software License 1.0", + "LZMA SDK License (versions 9.11 to 9.20)", + "Condor Public License v1.1", + "Creative Commons Attribution 3.0 United States", + "CeCILL-C Free Software License Agreement", + "diffmark license", + "Historical Permission Notice and Disclaimer - Kevlin Henney variant", + "GNU Free Documentation License v1.1", + "Standard ML of New Jersey License", + "Reciprocal Public License 1.1", + "Hippocratic License 2.1", + "swrule License", + "Common Development and Distribution License 1.0", + "Microsoft Reciprocal License", + "Any OSI License - Perl Modules", + "CNRI Python License", + "Open LDAP Public License v2.3", + "Licence Libre du Québec – Permissive version 1.1", + "Python License 2.0.1", + "MakeIndex License", + "Academic Free License v1.2", + "Creative Commons Attribution No Derivatives 2.0 Generic", + "Fraunhofer FDK AAC Codec Library", + "SL License", + "Technische Universitaet Berlin License 1.0", + "GNU General Public License v1.0 or later", + "Saxpath License", + "dvipdfm License", + "BSD 2-Clause - Ian Darwin variant", + "Common Public Attribution License 1.0", + "copyleft-next 0.3.1", + "NetCDF license", + "Freetype Project License", + "DocBook Schema License", + "CERN Open Hardware Licence Version 2 - Strongly Reciprocal", + "X11 License Distribution Modification Variant", + "copyleft-next 0.3.0", + "X11 License", + "Creative Commons Attribution Non Commercial Share Alike 2.0 Germany", + "GNU Free Documentation License v1.3 only", + "Bahyph License", + "GNU Lesser General Public License v3.0 or later", + "Zope Public License 1.1", + "gSOAP Public License v1.3b", + "JasPer License", + "Sendmail Open Source License v1.1", + "Business Source License 1.1", + "Eurosym License", + "ThirdEye License", + "Creative Commons Share Alike 1.0 Generic", + "Sybase Open Watcom Public License 1.0", + "Caldera License", + "The Parity Public License 7.0.0", + "Secure Messaging Protocol Public License", + "Affero General Public License v1.0", + "Mulan Permissive Software License, Version 2", + "Afmparse License", + "GNU Free Documentation License v1.2 or later - no invariants", + "Lucida Bitmap Fonts License", + "Detection Rule License 1.0", + "Creative Commons Attribution Non Commercial 2.5 Generic", + "GD License", + "Zend License v2.0", + "Cronyx License", + "TTYP0 License", + "Creative Commons Attribution No Derivatives 1.0 Generic", + "Ferguson Twofish License", + "Scheme Language Report License", + "MIT Khronos - old variant", + "LPD Documentation License", + "Universal Permissive License v1.0", + "CeCILL Free Software License Agreement v1.1", + "Crossword License", + "Computational Use of Data Agreement v1.0", + "Hewlett-Packard BSD variant license", + "Apache License 1.0", + "CERN Open Hardware Licence v1.1", + "Sun Industry Standards Source License v1.1", + "Mozilla Public License 2.0 (no copyleft exception)", + "Open Logistics Foundation License Version 1.3", + "Inner Net License v2.0", + "Licence Libre du Québec – Réciprocité version 1.1", + "BSD 4.3 TAHOE License", + "Academic Free License v2.0", + "GNU Free Documentation License v1.2 or later - invariants", + "Creative Commons Attribution Non Commercial No Derivatives 2.5 Generic", + "Open LDAP Public License v2.4", + "Brian Gladman 3-Clause License", + "gtkbook License", + "SIL Open Font License 1.0 with no Reserved Font Name", + "Licence Art Libre 1.3", + "threeparttable License", + "Imlib2 License", + "Adobe Display PostScript License", + "X.Net License", + "Open Software License 2.1", + "Open LDAP Public License v2.2", + "Microsoft Limited Public License", + "Mup License", + "GNU Lesser General Public License v3.0 only", + "BSD 4.3 RENO License", + "MIT Click License", + "W3C Software Notice and Document License (2015-05-13)", + "Open Software License 2.0", + "Eclipse Public License 2.0", + "GNU Free Documentation License v1.3", + "ASWF Digital Assets License version 1.0", + "Apple Public Source License 1.1", + "Historical Permission Notice and Disclaimer", + "Linux Kernel Variant of OpenIB.org license", + "Zeeff License", + "Open Government Licence v3.0", + "Creative Commons Attribution No Derivatives 3.0 Germany", + "BSD 4 Clause Shortened", + "BSD 2-Clause FreeBSD License", + "gnuplot License", + "PNG Reference Library version 2", + "Leptonica License", + "Clips License", + "OpenSSL License", + "Sendmail License", + "NCBI Public Domain Notice", + "TrustedQSL License", + "Catharon License", + "European Union Public License 1.2", + "Wsuipa License", + "Open Government Licence v2.0", + "ISC Veillard variant", + "Creative Commons Attribution 3.0 Netherlands", + "AdaCore Doc License", + "Affero General Public License v1.0 only", + "libselinux public domain notice", + "Historical Permission Notice and Disclaimer - Fenneberg-Livingston variant", + "Xdebug License v 1.03", + "Jam License", + "GNU General Public License v2.0 w/Classpath exception", + "check-cvs License", + "AMD newlib License", + "Creative Commons Attribution Non Commercial 1.0 Generic", + "xinetd License", + "BSD 4-Clause \"Original\" or \"Old\" License", + "IBM PowerPC Initialization and Boot Software", + "Apache License 2.0", + "Linux man-pages - 1 paragraph", + "Code Project Open License 1.02", + "BSD Source Code Attribution - beginning of file variant", + "CERN Open Hardware Licence Version 2 - Permissive", + "OFFIS License", + "GNU General Public License v2.0 or later", + "radvd License", + "Xfig License", + "Multics License", + "Academic Free License v1.1", + "Beerware License", + "Microsoft Public License", + "ssh-keyscan License", + "Spencer License 99", + "SIL Open Font License 1.1", + "Baekmuk License", + "Qhull License", + "GNU Free Documentation License v1.2 or later", + "Creative Commons Attribution Non Commercial Share Alike 4.0 International", + "Apple Public Source License 2.0", + "VOSTROM Public License for Open Source", + "Net-SNMP License", + "Historical Permission Notice and Disclaimer - documentation variant", + "NRL License", + "Time::ParseDate License", + "Affero General Public License v1.0 or later", + "Historical Permission Notice and Disclaimer - Markus Kuhn variant", + "LZMA SDK License (versions 9.22 and beyond)", + "Unicode License v3", + "GNU General Public License v3.0 or later", + "OpenSSL License - standalone", + "Zimbra Public License v1.3", + "xkeyboard-config Zinoviev License", + "GNU Free Documentation License v1.1 only - invariants", + "Open Market License", + "ANTLR Software Rights Notice", + "Historical Permission Notice and Disclaimer with MIT disclaimer", + "Dotseqn License", + "Historical Permission Notice and Disclaimer - DEC variant", + "GNU Library General Public License v2 only", + "Creative Commons Attribution 2.5 Australia", + "DEC 3-Clause License", + "Q Public License 1.0 - INRIA 2004 variant", + "Intel Open Source License", + "NIST Public Domain Notice with license fallback", + "Creative Commons Attribution Non Commercial 4.0 International", + "BSD 3-Clause No Nuclear Warranty", + "Historical Permission Notice and Disclaimer - University of California variant", + "MIT Tom Wu Variant", + "Kastrup License", + "CMU License", + "Data licence Germany – zero – version 2.0", + "NIST Software License", + "Spencer License 94", + "Creative Commons Attribution 2.0 Generic", + "European Union Public License 1.1", + "HPND with US Government export control warning and modification rqmt", + "Generic XTS License", + "No Limit Public License", + "University of Illinois/NCSA Open Source License", + "Python Software Foundation License 2.0", + "Linux man-pages Copyleft Variant", + "Open Software License 1.1", + "mpi Permissive License", + "Glulxe License", + "Licence Art Libre 1.2", + "SMAIL General Public License", + "NASA Open Source Agreement 1.3", + "Sun Public License v1.0", + "BSD Advertising Acknowledgement License", + "BSD 3-Clause Modification", + "3D Slicer License v1.0", + "Netscape Public License v1.1", + "GNU General Public License v2.0 w/GCC Runtime Library exception", + "Independent JPEG Group License - short", + "Creative Commons Attribution 4.0 International", + "ulem License", + "BSD 3-Clause Sun Microsystems", + "Sax Public Domain Notice 2.0", + "TORQUE v2.5+ Software License v1.1", + "Technische Universitaet Berlin License 2.0", + "Borceux license", + "BSD Zero Clause License", + "Mackerras 3-Clause License", + "GNU Free Documentation License v1.3 or later - invariants", + "Knuth CTAN License", + "Non-Profit Open Software License 3.0", + "Open LDAP Public License v1.4", + "Intel ACPI Software License Agreement", + "Adobe Glyph List License", + "BSD with attribution", + "metamail License", + "Zed License", + "Sun PPP License (2000)", + "SGI Free Software License B v1.0", + "xlock License", + "GNU Affero General Public License v3.0", + "SCEA Shared Source License", + "Artistic License 2.0", + "ICU License", + "Creative Commons Attribution 2.5 Generic", + "Solderpad Hardware License, Version 0.51", + "LaTeX Project Public License v1.3a", + "Community Data License Agreement Permissive 1.0", + "Eiffel Forum License v2.0", + "Utah Raster Toolkit Run Length Encoded License", + "Historical Permission Notice and Disclaimer - sell regexpr variant", + "GNU Free Documentation License v1.3 or later - no invariants", + "AMD's plpa_map.c License", + "Bitstream Charter Font License", + "Python ldap License", + "Creative Commons Attribution Share Alike 3.0 Austria", + "OGC Software License, Version 1.0", + "Creative Commons Attribution Share Alike 2.0 Generic", + "PADL License", + "NICTA Public Software License, Version 1.0", + "Lucent Public License Version 1.0", + "LaTeX Project Public License v1.1", + "Common Documentation License 1.0", + "Boehm-Demers-Weiser GC License", + "Sun PPP License", + "Open LDAP Public License v2.2.1", + "GNU Affero General Public License v3.0 or later", + "Open LDAP Public License v2.6", + "BSD 3-Clause No Nuclear License", + "BSD Protection License", + "Open CASCADE Technology Public License", + "GNU General Public License v2.0 w/Font exception", + "Yahoo! Public License v1.0", + "MIPS License", + "SGI Free Software License B v2.0", + "MIT Open Group variant", + "Apple MIT License", + "Open Software License 1.0", + "GNU Free Documentation License v1.3 only - invariants", + "bzip2 and libbzip2 License v1.0.5", + "Symlinks License", + "Ruby pty extension license", + "UCAR License", + "Simple Public License 2.0", + "PolyForm Noncommercial License 1.0.0", + "SIL Open Font License 1.1 with no Reserved Font Name", + "Furuseth License", + "Mackerras 3-Clause - acknowledgment variant", + "Creative Commons Public Domain Mark 1.0 Universal", + "zlib License", + "BSD 2-Clause with views sentence", + "Interbase Public License v1.0", + "Creative Commons Attribution Non Commercial Share Alike 3.0 Unported", + "MIT License Modern Variant", + "Unicode Terms of Use", + "Adobe Postscript AFM License", + "TCL/TK License", + "Xerox License", + "FSF Unlimited License", + "FSF All Permissive License (without Warranty)", + "Artistic License 1.0", + "ImageMagick License", + "Brian Gladman 2-Clause License", + "BitTorrent Open Source License v1.1", + "GNU General Public License v3.0 only", + "Linux man-pages Copyleft", + "NTP No Attribution", + "curl License", + "MIT +no-false-attribs license", + "libtiff License", + "Erlang Public License v1.1", + "Adobe Utopia Font License", + "Haskell Language Report License", + "ISC License", + "Naumen Public License", + "Creative Commons Attribution Share Alike 1.0 Generic", + "Etalab Open License 2.0", + "MPEG Software Simulation", + "CFITSIO License", + "Mulan Permissive Software License, Version 1", + "BSD-2-Clause Plus Patent License", + "Creative Commons Public Domain Dedication and Certification", + "Transitive Grace Period Public Licence 1.0", + "snprintf License", + "Nunit License", + "Boehm-Demers-Weiser GC License (without fee)", + "Pixar License", + "Historical Permission Notice and Disclaimer - Netrek variant", + "Minpack License", + "GNU Free Documentation License v1.1 only", + "Historical Permission Notice and Disclaimer - INRIA-IMAG variant", + "App::s2p License", + "BSD 3-Clause acpica variant", + "Open Group Test Suite License", + "Open Data Commons Open Database License v1.0", + "Creative Commons Attribution No Derivatives 3.0 Unported", + "Creative Commons Attribution Share Alike 2.5 Generic", + "Open LDAP Public License v2.7", + "Upstream Compatibility License v1.0", + "Matrix Template Library License", + "HPND with US Government export control and 2 disclaimers", + "SIL Open Font License 1.0 with Reserved Font Name", + "Zope Public License 2.0", + "bcrypt Solar Designer License", + "Creative Commons Attribution Non Commercial Share Alike 3.0 Germany", + "GNU Free Documentation License v1.1 or later - no invariants", + "Creative Commons Attribution-ShareAlike 3.0 IGO", + "Apache License 1.1", + "GNU General Public License v2.0 w/Autoconf exception", + "Caldera License (without preamble)", + "Server Side Public License, v 1", + "Detection Rule License 1.1", + "Linux man-pages Copyleft - 2 paragraphs", + "Open LDAP Public License v2.0.1", + "ANTLR Software Rights Notice with license fallback", + "Community Data License Agreement Permissive 2.0", + "HIDAPI License", + "bzip2 and libbzip2 License v1.0.6", + "GL2PS License", + "Trusster Open Source License", + "Abstyles License", + "TermReadKey License", + "GNU Free Documentation License v1.2", + "xzoom License", + "PostgreSQL License", + "CNRI Python Open Source GPL Compatible License Agreement", + "Widget Workshop License", + "libpng License", + "Historical Permission Notice and Disclaimer - sell xserver variant with MIT disclaimer", + "Creative Commons Attribution Non Commercial Share Alike 1.0 Generic", + "Python License 2.0", + "Systemics W3Works BSD variant license", + "LaTeX Project Public License v1.0", + "Yahoo! Public License v1.1", + "Scheme Widget Library (SWL) Software License Agreement", + "Giftware License", + "CeCILL-B Free Software License Agreement", + "OSET Public License version 2.1", + "GNU General Public License v3.0 w/Autoconf exception", + "Cryptographic Autonomy License 1.0 (Combined Work Exception)", + "HPND sell variant with MIT disclaimer - reverse", + "JSON License", + "GNU Free Documentation License v1.2 only", + "pkgconf License", + "Unicode License Agreement - Data Files and Software (2016)", + "PHP License v3.01", + "SQLite Blessing", + "RealNetworks Public Source License v1.0", + "BitTorrent Open Source License v1.0", + "Sun Industry Standards Source License v1.2", + "Independent JPEG Group License", + "Open Government Licence - Canada", + "Creative Commons Attribution No Derivatives 2.5 Generic", + "Historical Permission Notice and Disclaimer - Pbmplus variant", + "Creative Commons Attribution Non Commercial No Derivatives 3.0 Germany", + "Reciprocal Public License 1.5", + "Nokia Open Source License", + "Historical Permission Notice and Disclaimer - documentation sell variant" + ], + "description": "Known license Names.\n\nSPDX License List from spdx-license-list npm package Imported here as const to provide richer types for the License type.", + "markdownDescription": "Known license Names.\n\nSPDX License List from spdx-license-list npm package\nImported here as const to provide richer types for the License type." + }, + "LicenseURL": { + "anyOf": [ + { + "$ref": "#/definitions/KnownLicenseURLs" + }, + { + "type": "string" + } + ], + "description": "Open enum of SPDX license URLs. Suggests all known license URLs, but also accepts custom strings.\n\nThe SPDX License List is sourced from the spdx-license-list npm package Imported here as const to provide richer types for the License type.", + "markdownDescription": "Open enum of SPDX license URLs.\nSuggests all known license URLs, but also accepts custom strings.\n\nThe SPDX License List is sourced from the spdx-license-list npm package\nImported here as const to provide richer types for the License type." + }, + "KnownLicenseURLs": { + "type": "string", + "enum": [ + "https://fedoraproject.org/wiki/Licensing/DSDP", + "https://github.com/tcheneau/simpleRPL/blob/e645e69e38dd4e3ccfeceb2db8cba05b7c2e0cd3/LICENSE.txt", + "https://creativecommons.org/licenses/by-nc-sa/2.0/legalcode", + "http://data.norge.no/nlod/en/1.0", + "http://ecos.sourceware.org/old-license.html", + "https://www.gnu.org/licenses/fdl-1.3.txt", + "http://wayback.archive.org/web/20060715140826/http://www.risource.org/RPL/RPL-1.0A.shtml", + "https://github.com/AcademySoftwareFoundation/foundation/blob/main/digital_assets/aswf_digital_assets_license_v1.1.txt", + "https://www.gnu.org/licenses/ecos-license.html", + "https://github.com/me-shaon/GLWTPL/commit/da5f6bc734095efbacb442c0b31e33a65b9d6e85", + "http://www.info-zip.org/license.html", + "http://www.latex-project.org/lppl/lppl-1-3c.txt", + "https://fedoraproject.org/wiki/Licensing/ZlibWithAcknowledgement", + "https://github.com/libcheck/check/blob/master/checkmk/checkmk.in", + "http://www.openldap.org/software/release/license.html", + "https://www.cve.org/Legal/TermsOfUse", + "https://opensource.org/licenses/MirOS", + "https://paritylicense.com/versions/6.0.0.html", + "https://creativecommons.org/licenses/by-sa/2.1/jp/legalcode", + "https://github.com/jrsoftware/issrc/blob/HEAD/license.txt", + "https://opensource.org/licenses/IPL-1.0", + "https://fedoraproject.org/wiki/Licensing/Henry_Spencer_Reg-Ex_Library_License", + "https://gitlab.isc.org/isc-projects/bind9/blob/master/COPYRIGHT#L366", + "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L66-L98", + "https://celestrak.org/publications/AIAA/2006-6753/faq.php", + "http://www.mozilla.org/MPL/MPL-1.1.html", + "http://labs.metacarta.com/license-explanation.html#license", + "https://github.com/KhronosGroup/glslang/blob/main/LICENSE.txt#L949", + "http://vimdoc.sourceforge.net/htmldoc/uganda.html", + "https://github.com/CommunitySpecification/1.0/blob/master/1._Community_Specification_License-v1.md", + "https://web.archive.org/web/20120101081418/http://rosenlaw.com:80/OSL3.0.htm", + "https://fedoraproject.org/wiki/Licensing:CrystalStacker?rd=Licensing/CrystalStacker", + "http://www.mozilla.org/MPL/MPL-1.0.html", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=42b0383c50c299977b5893ee695cf4e486fb0dc7", + "https://www.proofpoint.com/sites/default/files/sendmail-license.pdf", + "https://www.cs.cmu.edu/~410/licenses.html", + "https://fedoraproject.org/wiki/Licensing/xpp", + "http://git.savannah.gnu.org/cgit/bison.git/tree/data/yacc.c?id=193d7c7054ba7197b0789e14965b739162319b5e#n141", + "https://opensource.org/licenses/ECL-1.0", + "https://fedoraproject.org/wiki/Licensing/Plexus_Classworlds_License", + "https://www.elastic.co/licensing/elastic-license", + "https://opensource.org/licenses/CPL-1.0", + "https://www.gnu.org/licenses/old-licenses/fdl-1.2.txt", + "http://old.koalateam.com/jackaroo/OPL_1_0.TXT", + "https://creativecommons.org/licenses/by-sa/4.0/legalcode", + "https://fedoraproject.org/wiki/Licensing/AmazonDigitalServicesLicense", + "http://oss.sgi.com/projects/FreeB/", + "http://www.xfree86.org/current/LICENSE4.html", + "https://git.savannah.gnu.org/cgit/indent.git/tree/doc/indent.texi?id=a74c6b4ee49397cf330b333da1042bffa60ed14f#n74", + "https://opensource.org/licenses/IPA", + "https://fedoraproject.org/wiki/Licensing/psutils", + "https://creativecommons.org/licenses/by-nc-nd/3.0/legalcode", + "https://fedoraproject.org/wiki/Licensing/FSF_Unlimited_License#License_Retention_Variant", + "https://www.tq-group.com/filedownloads/files/software-license-conditions/OriginalSSLeay/OriginalSSLeay.pdf", + "https://gitlab.lrz.de/mmix/mmixware/-/blob/master/boilerplate.w", + "https://github.com/erich666/GraphicsGems/blob/master/LICENSE.md", + "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L831-L852", + "https://creativecommons.org/licenses/by-nc/2.0/legalcode", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=e5f8117f0ce088d0bd7a8e18ddf37eaa40eb09b1", + "https://www.gnu.org/licenses/old-licenses/lgpl-2.1-standalone.html", + "http://data.norge.no/nlod/en/2.0", + "https://opensource.org/licenses/BSD-2-Clause", + "https://fossies.org/linux/sendmail/contrib/mailprio", + "https://creativecommons.org/licenses/by-sa/3.0/legalcode", + "https://fedoraproject.org/wiki/Licensing/Noweb", + "https://metacpan.org/release/RJBS/Text-Soundex-3.05/source/Soundex.pm#L3-11", + "http://www.cecill.info/licences/Licence_CeCILL_V1-fr.html", + "http://pages.cs.wisc.edu/~ghost/doc/AFPL/6.01/Public.htm", + "https://github.com/openssh/openssh-portable/blob/1b11ea7c58cd5c59838b5fa574cd456d6047b2d4/LICENCE#L10", + "https://github.com/cyrusimap/cyrus-sasl/blob/master/COPYING", + "https://creativecommons.org/licenses/by-nc-sa/2.0/uk/legalcode", + "http://git.savannah.gnu.org/cgit/kazlib.git/tree/except.c?id=0062df360c2d17d57f6af19b0e444c51feb99036", + "https://ubuntu.com/legal/font-licence", + "https://gitlab.freedesktop.org/mesa/glw/-/blob/master/README?ref_type=heads", + "https://fedoraproject.org/wiki/Licensing/Rdisc_License", + "https://github.com/sigmavirus24/x11-ssh-askpass/blob/master/README", + "http://www-igm.univ-mlv.fr/~unitex/lgpllr.html", + "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/string/strsignal.c;hb=HEAD#l35", + "https://github.com/htacg/tidy-html5/blob/next/README/LICENSE.md", + "https://fedoraproject.org/wiki/Licensing/BSD#AMPASBSD", + "http://bits.netizen.com.au/licenses/NOSL/nosl.txt", + "https://mirrors.nic.cz/tex-archive/macros/latex/contrib/fwlw/README", + "https://github.com/tats/w3m/blob/master/COPYING", + "https://fedoraproject.org/wiki/Licensing/Latex2e", + "https://github.com/microsoft/Open-Use-of-Data-Agreement/blob/v1.0/O-UDA-1.0.md", + "https://fedoraproject.org/wiki/Licensing:Mplus?rd=Licensing/mplus", + "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/machine/i960/memcpy.S;hb=HEAD", + "https://wiki.p2pfoundation.net/Peer_Production_License", + "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web", + "http://www.eclipse.org/legal/epl-v10.html", + "https://github.com/RTimothyEdwards/magic/blob/master/LICENSE", + "https://creativecommons.org/licenses/by/3.0/de/legalcode", + "https://fedoraproject.org/wiki/Licensing/SNIA_Public_License", + "https://fedoraproject.org/wiki/Licensing/Barr", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=b0d176738e96a0d3b9f85cb51e140a86f21be715", + "https://creativecommons.org/licenses/by-nd/4.0/legalcode", + "https://github.com/mm2/Little-CMS/blob/master/src/cmssm.c#L207", + "http://scripts.sil.org/cms/scripts/page.php?item_id=OFL10_web", + "https://github.com/westes/flex/blob/master/COPYING", + "https://fedoraproject.org/wiki/Licensing/psfrag", + "https://svnweb.freebsd.org/base/head/include/ifaddrs.h?revision=326823", + "https://gitlab.syncad.com/hive/dhive/-/blob/master/LICENSE", + "https://fedoraproject.org/wiki/Licensing/Cube", + "http://www.latex-project.org/lppl/lppl-1-2.txt", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=df2cc1e21eb7c160695f5b7cffd6296c151ba188", + "https://fedoraproject.org/wiki/Licensing/TTWL", + "https://creativecommons.org/licenses/by/3.0/legalcode", + "https://www.open-mpi.org/community/license.php", + "https://creativecommons.org/licenses/by-nc-nd/3.0/igo/legalcode", + "http://old.zope.org/Resources/ZPL/", + "https://creativecommons.org/publicdomain/zero/1.0/legalcode", + "http://www.mozilla.org/MPL/NPL/1.0/", + "http://www.cecill.info/licences/Licence_CeCILL_V2-en.html", + "http://www.db.net/downloads/wwl+db-1.3.tgz", + "https://opensource.org/licenses/NGPL", + "https://www.gnu.org/prep/maintain/html_node/License-Notices-for-Other-Files.html", + "https://metacpan.org/pod/Exporter::Tidy#LICENSE", + "https://fedoraproject.org/wiki/Licensing/MIT", + "http://eu-datagrid.web.cern.ch/eu-datagrid/license.html", + "https://opensource.org/licenses/Sleepycat", + "http://www.rosenlaw.com/AFL3.0.htm", + "http://ftp.gnu.org/gnu/non-gnu/chinese-fonts-truetype/LICENSE", + "http://www.freebsd.org/copyright/license.html", + "https://github.com/SWI-Prolog/swipl-devel/blob/master/src/os/dtoa.c", + "https://web.archive.org/web/20151224134844/http://unicode.org/copyright.html", + "http://rc.quest.com/topics/openssh/license.php#tcpwrappers", + "https://github.com/aws/mit-0", + "http://www.sugarcrm.com/crm/SPL", + "http://legacy.imatix.com/html/sfl/sfl4.htm#license", + "https://creativecommons.org/licenses/by/3.0/at/legalcode", + "https://fedoraproject.org/wiki/Licensing/AdobeLicense", + "https://gitlab.com/embeddable-common-lisp/ecl/-/blob/develop/src/lsp/loop.lsp", + "https://github.com/dotnet/runtime/blob/55e1ac7c07df62c4108d4acedf78f77574470ce5/src/libraries/System.Text.RegularExpressions/tests/FunctionalTests/AttRegexTests.cs#L12-L28", + "http://www.egenix.com/products/eGenix.com-Public-License-1.1.0.pdf", + "https://github.com/GNOME/gcr/blob/master/docs/COPYING", + "https://opensource.org/licenses/attribution", + "http://cryptographicautonomylicense.com/license-text.html", + "http://www.php.net/license/3_0.txt", + "https://github.com/Distrotech/hdparm/blob/4517550db29a91420fb2b020349523b1b4512df2/LICENSE.TXT", + "https://github.com/adaptivecomputing/torque/blob/master/PBS_License.txt", + "https://www.govdata.de/dl-de/by-2-0", + "https://www.ohwr.org/project/licenses/wikis/cern-ohl-v1.2", + "https://opensource.org/license/mit/", + "https://fedoraproject.org/wiki/Licensing/XSkat_License", + "https://www.cs.auckland.ac.nz/~pgut001/dumpasn1.c", + "https://opensource.org/licenses/WXwindows", + "https://creativecommons.org/licenses/by-nc-sa/2.5/legalcode", + "http://opendatacommons.org/licenses/pddl/1.0/", + "https://unlicense.org/", + "https://opensource.org/licenses/CUA-OPL-1.0", + "https://gitlab.freedesktop.org/pipewire/pipewire/-/blob/master/src/modules/module-filter-chain/pffft.c?ref_type=heads#L1-52", + "https://www.gnu.org/licenses/old-licenses/fdl-1.1.txt", + "http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.html", + "https://polyformproject.org/licenses/small-business/1.0.0", + "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/machine/hppa/memchr.S;h=1cca3e5e8867aa4bffef1f75a5c1bba25c0c441e;hb=HEAD#l2", + "https://www.kermitproject.org/ck90.html#source", + "https://github.com/fedeinthemix/chez-srfi/blob/master/srfi/LICENSE", + "https://solderpad.org/licenses/SHL-0.5/", + "https://metacpan.org/release/DPARIS/Crypt-DES-2.07/source/COPYRIGHT", + "https://cdla.io/sharing-1-0", + "https://fedoraproject.org/wiki/Licensing/Newsletr", + "http://svnkit.com/license.html", + "https://epics.anl.gov/license/open.php", + "http://www.saxproject.org/copying.html", + "https://github.com/festvox/flite/blob/master/COPYING", + "https://www.gnu.org/licenses/old-licenses/lgpl-2.0-standalone.html", + "http://doc.qt.nokia.com/3.3/license.html", + "https://github.com/openssh/openssh-portable/blob/1b11ea7c58cd5c59838b5fa574cd456d6047b2d4/pathnames.h", + "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/1/", + "https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html", + "https://www.gnu.org/licenses/gcc-exception-3.1.html", + "https://opensource.org/licenses/ECL-2.0", + "https://opensource.org/licenses/CATOSL-1.1", + "https://android.googlesource.com/platform/external/dng_sdk/+/refs/heads/master/source/dng_lossless_jpeg.cpp#16", + "http://www.cs.wustl.edu/~schmidt/ACE-copying.html", + "http://www.faqs.org/rfcs/rfc1321.html", + "http://www.oclc.org/research/activities/software/license/v2final.htm", + "https://www.gnu.org/licenses/agpl.txt", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=6852b9d90022e8593c98205413380536b1b5a7cf", + "https://creativecommons.org/licenses/by-sa/3.0/de/legalcode", + "http://dev.perl.org/licenses/artistic.html", + "https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode", + "https://java.net/projects/javaeetutorial/pages/BerkeleyLicense", + "https://github.com/Perl/perl5/blob/blead/util.c#L6136", + "http://ec.europa.eu/idabc/en/document/7330.html", + "https://mirror.las.iastate.edu/tex-archive/graphics/metapost/contrib/macros/slideshow/slideshow.mp", + "https://creativecommons.org/licenses/by-nd-nc/1.0/legalcode", + "https://blueoakcouncil.org/license/1.0.0", + "https://opendatacommons.org/licenses/by/1.0/", + "https://coil.apotheon.org/plaintext/01.0.txt", + "https://web.archive.org/web/20080207013128/http://www.gnome.org/fonts/", + "https://www.jpl.nasa.gov/jpl-image-use-policy", + "https://fedoraproject.org/wiki/Licensing/MIT#enna", + "https://www.inet.no/dante/LICENSE", + "http://glassfish.java.net/public/CDDL+GPL_1_1.html", + "https://lists.gnu.org/archive/html/autoconf/2012-04/msg00061.html", + "http://www.eiffel-nice.org/license/forum.txt", + "https://opensource.org/licenses/Entessa", + "http://www.users.on.net/~triforce/glidexp/COPYING.txt", + "https://creativecommons.org/licenses/by-nc/3.0/de/legalcode", + "https://opensource.org/licenses/Artistic-1.0", + "http://www.w3.org/Consortium/Legal/copyright-software-19980720.html", + "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/misc/fini.c;hb=HEAD", + "https://opensource.org/licenses/Motosoto", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=806557a5ad59804ef3a44d5abfbe91d706b0791f", + "https://github.com/bleargh45/Data-UUID/blob/master/LICENSE", + "https://www.iec.ch/webstore/custserv/pdf/CC-EULA.pdf", + "http://www.nationalarchives.gov.uk/doc/non-commercial-government-licence/version/2/", + "https://creativecommons.org/licenses/by/3.0/igo/legalcode", + "https://github.com/robbiehanson/CocoaHTTPServer/blob/master/LICENSE.txt", + "http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231.html", + "https://mirrors.nic.cz/tex-archive/macros/latex/contrib/magaz/magaz.tex", + "http://web.mit.edu/freebsd/head/lib/libutil/login_ok.3", + "http://opensource.linux-mirror.org/licenses/afl-2.1.txt", + "https://enterprise.dejacode.com/licenses/public/naist-2003/#license-text", + "https://github.com/docbook/xslt10-stylesheets/blob/efd62655c11cc8773708df7a843613fa1e932bf8/xsl/COPYING#L27", + "https://www.forge.gouv.qc.ca/participez/licence-logicielle/licence-libre-du-quebec-liliq-en-francais/licence-libre-du-quebec-reciprocite-forte-liliq-r-v1-1/", + "https://fedoraproject.org/wiki/Licensing/MIT#feh", + "https://github.com/radcli/radcli/blob/master/COPYRIGHT#L64", + "https://creativecommons.org/licenses/by-nc/3.0/legalcode", + "https://www.gnu.org/licenses/old-licenses/gpl-1.0-standalone.html", + "https://opensource.org/licenses/NTP", + "https://opensource.org/licenses/Frameworx-1.0", + "http://www.netbsd.org/about/redistribution.html#default", + "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/net/sunrpc/auth_gss/gss_generic_token.c?h=v4.19", + "https://creativecommons.org/licenses/by/1.0/legalcode", + "https://opensource.org/licenses/APL-1.0", + "http://www.wtfpl.net/about/", + "https://github.com/SWI-Prolog/packages-xpce/blob/161a40cd82004f731ba48024f9d30af388a7edf5/src/img/gifwrite.c#L21-L26", + "http://gianluca.dellavedova.org/2011/01/03/clarified-artistic-license/", + "https://github.com/freebsd/freebsd-src/blob/main/lib/msun/src/e_acosh.c", + "https://opensource.org/licenses/VSL-1.0", + "https://creativecommons.org/licenses/by-nc-sa/3.0/igo/legalcode", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=37b4b3f6cc4bf34e1d3dec61e69914b9819d8894", + "http://opencontent.org/openpub/", + "https://creativecommons.org/licenses/by-nc-nd/2.0/legalcode", + "https://fedoraproject.org/wiki/Licensing/LBNLBSD", + "https://www.ruby-lang.org/en/about/license.txt", + "https://web.archive.org/web/20150926120323/http://fairlicense.org/", + "https://fedoraproject.org/wiki/Licensing/MIT_With_Advertising", + "https://data.gov.tw/license", + "https://www.parliament.uk/site-information/copyright-parliament/open-parliament-licence/", + "https://www.mozilla.org/MPL/2.0/", + "http://www.docbook.org/xml/5.0/docbook-5.0.zip", + "https://fedoraproject.org/wiki/Licensing:ThorPublicLicense", + "https://www.tapr.org/OHL", + "https://foss.heptapod.net/python-libs/passlib/-/blob/branch/stable/LICENSE#L70", + "https://www.freebsd.org/copyright/freebsd-doc-license/", + "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L718-L728", + "https://creativecommons.org/licenses/by/3.0/au/legalcode", + "http://www.zimbra.com/legal/zimbra-public-license-1-4", + "https://opensource.org/licenses/BSD-3-Clause", + "https://github.com/lsof-org/lsof/blob/master/COPYING", + "http://freeimage.sourceforge.net/freeimage-license.txt", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=cbf50f4e1185a21abd4c0a54d3f4341fe28f36ea", + "http://www.samurajdata.se/opensource/mirror/licenses/apsl.php", + "https://fedoraproject.org/wiki/Licensing/Apple_Public_Source_License_1.0", + "https://creativecommons.org/licenses/by-nc-sa/2.0/fr/legalcode", + "http://www.dipp.nrw.de/d-fsl/lizenzen/", + "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/editor/pnmstitch.c#l2", + "https://creativecommons.org/licenses/by-sa/2.0/uk/legalcode", + "https://www.ohwr.org/project/cernohl/wikis/Documents/CERN-OHL-version-2", + "http://plan9.bell-labs.com/plan9/license.html", + "http://www.jython.org/license.html", + "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L664-L690", + "http://www.boost.org/LICENSE_1_0.txt", + "https://www.7-zip.org/sdk.html", + "http://research.cs.wisc.edu/condor/license.html#condor", + "https://creativecommons.org/licenses/by/3.0/us/legalcode", + "http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html", + "https://fedoraproject.org/wiki/Licensing/diffmark", + "https://github.com/mruby/mruby/blob/83d12f8d52522cdb7c8cc46fad34821359f453e6/mrbgems/mruby-dir/src/Win/dirent.c#L127-L140", + "https://www.smlnj.org/license.html", + "https://opensource.org/licenses/RPL-1.1", + "https://firstdonoharm.dev/version/2/1/license.html", + "https://ctan.math.utah.edu/ctan/tex-archive/macros/generic/misc/swrule.sty", + "https://opensource.org/licenses/cddl1", + "http://www.microsoft.com/opensource/licenses.mspx", + "https://metacpan.org/release/JUERD/Exporter-Tidy-0.09/view/Tidy.pm#LICENSE", + "https://opensource.org/licenses/CNRI-Python", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=d32cf54a32d581ab475d23c810b0a7fbaf8d63c3", + "https://forge.gouv.qc.ca/licence/fr/liliq-v1-1/", + "https://www.python.org/download/releases/2.0.1/license/", + "https://fedoraproject.org/wiki/Licensing/MakeIndex", + "http://opensource.linux-mirror.org/licenses/afl-1.2.txt", + "https://creativecommons.org/licenses/by-nd/2.0/legalcode", + "https://fedoraproject.org/wiki/Licensing/FDK-AAC", + "https://github.com/mtoyoda/sl/blob/master/LICENSE", + "https://github.com/swh/ladspa/blob/7bf6f3799fdba70fda297c2d8fd9f526803d9680/gsm/COPYRIGHT", + "https://fedoraproject.org/wiki/Licensing/Saxpath_License", + "https://fedoraproject.org/wiki/Licensing/dvipdfm", + "https://github.com/file/file/blob/master/COPYING", + "https://opensource.org/licenses/CPAL-1.0", + "https://github.com/copyleft-next/copyleft-next/blob/master/Releases/copyleft-next-0.3.1", + "http://www.unidata.ucar.edu/software/netcdf/copyright.html", + "http://freetype.fis.uniroma2.it/FTL.TXT", + "https://github.com/docbook/xslt10-stylesheets/blob/efd62655c11cc8773708df7a843613fa1e932bf8/xsl/assembly/schema/docbook51b7.rnc", + "https://github.com/mirror/ncurses/blob/master/COPYING", + "https://github.com/copyleft-next/copyleft-next/blob/master/Releases/copyleft-next-0.3.0", + "http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3", + "https://creativecommons.org/licenses/by-nc-sa/2.0/de/legalcode", + "https://fedoraproject.org/wiki/Licensing/Bahyph", + "https://www.gnu.org/licenses/lgpl-3.0-standalone.html", + "http://old.zope.org/Resources/License/ZPL-1.1", + "http://www.cs.fsu.edu/~engelen/license.html", + "http://www.ece.uvic.ca/~mdadams/jasper/LICENSE", + "https://github.com/trusteddomainproject/OpenDMARC/blob/master/LICENSE.Sendmail", + "https://mariadb.com/bsl11/", + "https://fedoraproject.org/wiki/Licensing/Eurosym", + "https://sourceware.org/cgit/binutils-gdb/tree/include/coff/symconst.h#n11", + "https://creativecommons.org/licenses/sa/1.0/legalcode", + "https://opensource.org/licenses/Watcom-1.0", + "http://www.lemis.com/grog/UNIX/ancient-source-all.pdf", + "https://paritylicense.com/versions/7.0.0.html", + "https://github.com/dcblake/SMP/blob/master/Documentation/License.txt", + "http://www.affero.org/oagpl.html", + "https://license.coscl.org.cn/MulanPSL2", + "https://fedoraproject.org/wiki/Licensing/Afmparse", + "https://gitlab.freedesktop.org/xorg/font/bh-100dpi/-/blob/master/COPYING?ref_type=heads", + "https://github.com/Neo23x0/sigma/blob/master/LICENSE.Detection.Rules.md", + "https://creativecommons.org/licenses/by-nc/2.5/legalcode", + "https://libgd.github.io/manuals/2.3.0/files/license-txt.html", + "https://web.archive.org/web/20130517195954/http://www.zend.com/license/2_00.txt", + "https://gitlab.freedesktop.org/xorg/font/alias/-/blob/master/COPYING", + "https://people.mpi-inf.mpg.de/~uwe/misc/uw-ttyp0/", + "https://creativecommons.org/licenses/by-nd/1.0/legalcode", + "https://github.com/wernerd/ZRTPCPP/blob/6b3cd8e6783642292bad0c21e3e5e5ce45ff3e03/cryptcommon/twofish.c#L113C3-L127", + "https://github.com/KhronosGroup/SPIRV-Cross/blob/main/LICENSES/LicenseRef-KhronosFreeUse.txt", + "https://github.com/Cyan4973/xxHash/blob/dev/doc/xxhash_spec.md", + "https://opensource.org/licenses/UPL", + "http://www.cecill.info/licences/Licence_CeCILL_V1.1-US.html", + "https://fedoraproject.org/wiki/Licensing/Crossword", + "https://github.com/microsoft/Computational-Use-of-Data-Agreement/blob/master/C-UDA-1.0.md", + "https://github.com/zdohnal/hplip/blob/master/COPYING#L939", + "http://www.apache.org/licenses/LICENSE-1.0", + "https://www.ohwr.org/project/licenses/wikis/cern-ohl-v1.1", + "http://www.openoffice.org/licenses/sissl_license.html", + "https://openlogisticsfoundation.org/licenses/", + "https://fedoraproject.org/wiki/Licensing/Inner_Net_License", + "https://www.forge.gouv.qc.ca/participez/licence-logicielle/licence-libre-du-quebec-liliq-en-francais/licence-libre-du-quebec-reciprocite-liliq-r-v1-1/", + "https://github.com/389ds/389-ds-base/blob/main/ldap/include/sysexits-compat.h#L15", + "http://wayback.archive.org/web/20060924134533/http://www.opensource.org/licenses/afl-2.0.txt", + "https://creativecommons.org/licenses/by-nc-nd/2.5/legalcode", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=cd1284c4a91a8a380d904eee68d1583f989ed386", + "https://github.com/SWI-Prolog/packages-clib/blob/master/sha1/brg_endian.h", + "https://github.com/slogan621/gtkbook", + "https://artlibre.org/", + "https://fedoraproject.org/wiki/Licensing/Threeparttable", + "http://trac.enlightenment.org/e/browser/trunk/imlib2/COPYING", + "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L752", + "https://opensource.org/licenses/Xnet", + "http://web.archive.org/web/20050212003940/http://www.rosenlaw.com/osl21.htm", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=470b0c18ec67621c85881b2733057fecf4a1acc3", + "https://www.openhub.net/licenses/mslpl", + "https://fedoraproject.org/wiki/Licensing/Mup", + "https://sourceware.org/git/?p=binutils-gdb.git;a=blob;f=libiberty/strcasecmp.c;h=131d81c2ce7881fa48c363dc5bf5fb302c61ce0b;hb=HEAD", + "https://github.com/kohler/t1utils/blob/master/LICENSE", + "https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document", + "http://web.archive.org/web/20041020171434/http://www.rosenlaw.com/osl2.0.html", + "https://www.eclipse.org/legal/epl-2.0", + "https://github.com/AcademySoftwareFoundation/foundation/blob/main/digital_assets/aswf_digital_assets_license_v1.0.txt", + "http://www.opensource.apple.com/source/IOSerialFamily/IOSerialFamily-7/APPLE_LICENSE", + "https://opensource.org/licenses/HPND", + "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/infiniband/core/sa.h", + "ftp://ftp.tin.org/pub/news/utils/newsx/newsx-1.6.tar.gz", + "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/", + "https://creativecommons.org/licenses/by-nd/3.0/de/legalcode", + "https://metadata.ftp-master.debian.org/changelogs//main/a/arpwatch/arpwatch_2.1a15-7_copyright", + "http://www.freebsd.org/copyright/freebsd-license.html", + "https://fedoraproject.org/wiki/Licensing/Gnuplot", + "http://www.libpng.org/pub/png/src/libpng-LICENSE.txt", + "https://fedoraproject.org/wiki/Licensing/Leptonica", + "https://github.com/DrItanium/maya/blob/master/LICENSE.CLIPS", + "http://www.openssl.org/source/license.html", + "http://www.sendmail.com/pdfs/open_source/sendmail_license.pdf", + "https://github.com/ncbi/sra-tools/blob/e8e5b6af4edc460156ad9ce5902d0779cffbf685/LICENSE", + "https://sourceforge.net/p/trustedqsl/tqsl/ci/master/tree/LICENSE.txt", + "https://github.com/scummvm/scummvm/blob/v2.8.0/LICENSES/CatharonLicense.txt", + "https://joinup.ec.europa.eu/page/eupl-text-11-12", + "https://fedoraproject.org/wiki/Licensing/Wsuipa", + "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/2/", + "https://raw.githubusercontent.com/GNOME/libxml2/4c2e7c651f6c2f0d1a74f350cbda95f7df3e7017/hash.c", + "https://creativecommons.org/licenses/by/3.0/nl/legalcode", + "https://github.com/AdaCore/xmlada/blob/master/docs/index.rst", + "https://github.com/SELinuxProject/selinux/blob/master/libselinux/LICENSE", + "https://github.com/FreeRADIUS/freeradius-client/blob/master/COPYRIGHT#L32", + "https://github.com/xdebug/xdebug/blob/master/LICENSE", + "https://www.boost.org/doc/libs/1_35_0/doc/html/jam.html", + "https://www.gnu.org/software/classpath/license.html", + "http://cvs.savannah.gnu.org/viewvc/cvs/ccvs/contrib/check_cvs.in?revision=1.1.4.3&view=markup&pathrev=cvs1-11-23#l2", + "https://sourceware.org/git/?p=newlib-cygwin.git;a=blob;f=newlib/libc/sys/a29khif/_close.S;h=04f52ae00de1dafbd9055ad8d73c5c697a3aae7f;hb=HEAD", + "https://creativecommons.org/licenses/by-nc/1.0/legalcode", + "https://fedoraproject.org/wiki/Licensing/Xinetd_License", + "http://directory.fsf.org/wiki/License:BSD_4Clause", + "http://git.denx.de/?p=u-boot.git;a=blob;f=arch/powerpc/cpu/ppc4xx/miiphy.c;h=297155fdafa064b955e53e9832de93bfb0cfb85b;hb=9fab4bf4cc077c21e43941866f3f2c196f28670d", + "https://www.apache.org/licenses/LICENSE-2.0", + "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/getcpu.2#n4", + "http://www.codeproject.com/info/cpol10.aspx", + "https://github.com/lattera/freebsd/blob/master/sys/cam/cam.c#L4", + "https://sourceforge.net/p/xmedcon/code/ci/master/tree/libs/dicom/README", + "https://github.com/radvd-project/radvd/blob/master/COPYRIGHT", + "https://github.com/Distrotech/transfig/blob/master/transfig/transfig.c", + "https://opensource.org/licenses/Multics", + "http://opensource.linux-mirror.org/licenses/afl-1.1.txt", + "https://fedoraproject.org/wiki/Licensing/Beerware", + "https://github.com/openssh/openssh-portable/blob/master/LICENCE#L82", + "http://www.opensource.apple.com/source/tcl/tcl-5/tcl/generic/regfronts.c", + "https://fedoraproject.org/wiki/Licensing:Baekmuk?rd=Licensing/Baekmuk", + "https://fedoraproject.org/wiki/Licensing/Qhull", + "https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode", + "http://www.opensource.apple.com/license/apsl/", + "https://fedoraproject.org/wiki/Licensing/VOSTROM", + "http://net-snmp.sourceforge.net/about/license.html", + "https://gitlab.freedesktop.org/xorg/lib/libxext/-/blob/master/COPYING?ref_type=heads#L185-197", + "http://web.mit.edu/network/isakmp/nrllicense.html", + "https://metacpan.org/pod/Time::ParseDate#LICENSE", + "https://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c", + "https://www.unicode.org/license.txt", + "https://www.gnu.org/licenses/gpl-3.0-standalone.html", + "https://library.netapp.com/ecm/ecm_download_file/ECMP1196395", + "http://web.archive.org/web/20100302225219/http://www.zimbra.com/license/zimbra-public-license-1-3.html", + "https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config/-/blob/master/COPYING?ref_type=heads#L178", + "https://fedoraproject.org/wiki/Licensing/Open_Market_License", + "http://www.antlr2.org/license.html", + "https://metacpan.org/release/NLNETLABS/Net-DNS-SEC-1.22/source/LICENSE", + "https://fedoraproject.org/wiki/Licensing/Dotseqn", + "https://gitlab.freedesktop.org/xorg/app/xkbcomp/-/blob/master/COPYING?ref_type=heads#L69", + "https://creativecommons.org/licenses/by/2.5/au/legalcode", + "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L239", + "https://github.com/maranget/hevea/blob/master/LICENSE", + "https://opensource.org/licenses/Intel", + "https://github.com/usnistgov/jsip/blob/59700e6926cbe96c5cdae897d9a7d2656b42abe3/LICENSE", + "https://creativecommons.org/licenses/by-nc/4.0/legalcode", + "https://jogamp.org/git/?p=gluegen.git;a=blob_plain;f=LICENSE.txt", + "https://core.tcl-lang.org/tk/file?name=compat/unistd.h", + "https://github.com/chromium/octane/blob/master/crypto.js", + "https://ctan.math.utah.edu/ctan/tex-archive/macros/generic/kastrup/binhex.dtx", + "https://fedoraproject.org/wiki/Licensing:MIT?rd=Licensing/MIT#CMU_Style", + "https://www.govdata.de/dl-de/zero-2-0", + "https://github.com/open-quantum-safe/liboqs/blob/40b01fdbb270f8614fde30e65d30e9da18c02393/src/common/rand/rand_nist.c#L1-L15", + "https://creativecommons.org/licenses/by/2.0/legalcode", + "https://joinup.ec.europa.eu/software/page/eupl/licence-eupl", + "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L1157-L1182", + "https://github.com/mhogomchungu/zuluCrypt/blob/master/external_libraries/tcplay/generic_xts.c", + "https://fedoraproject.org/wiki/Licensing/NLPL", + "http://otm.illinois.edu/uiuc_openSource", + "https://opensource.org/licenses/Python-2.0", + "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/set_mempolicy.2#n5", + "https://fedoraproject.org/wiki/Licensing/OSL1.1", + "https://sources.debian.org/src/openmpi/4.1.0-10/ompi/debuggers/msgq_interface.h/?hl=19#L19", + "https://fedoraproject.org/wiki/Licensing/Glulxe", + "http://artlibre.org/licence/lal/licence-art-libre-12/", + "https://sources.debian.org/copyright/license/debianutils/4.11.2/", + "http://ti.arc.nasa.gov/opensource/nosa/", + "https://opensource.org/licenses/SPL-1.0", + "https://github.com/python-excel/xlrd/blob/master/LICENSE#L33", + "https://fedoraproject.org/wiki/Licensing:BSD#Modification_Variant", + "https://slicer.org/LICENSE", + "http://www.mozilla.org/MPL/NPL/1.1/", + "https://gcc.gnu.org/git/?p=gcc.git;a=blob;f=gcc/libgcc1.c;h=762f5143fc6eed57b6797c82710f3538aa52b40b;hb=cb143a3ce4fb417c68f5fa2691a1b1b1053dfba9#l10", + "https://sourceforge.net/p/xmedcon/code/ci/master/tree/libs/ljpg/", + "https://creativecommons.org/licenses/by/4.0/legalcode", + "https://mirrors.ctan.org/macros/latex/contrib/ulem/README", + "https://github.com/xmlark/msv/blob/b9316e2f2270bc1606952ea4939ec87fbba157f3/xsdlib/src/main/java/com/sun/msv/datatype/regexp/InternalImpl.java", + "https://fedoraproject.org/wiki/Licensing/TORQUEv1.1", + "https://github.com/CorsixTH/deps/blob/fd339a9f526d1d9c9f01ccf39e438a015da50035/licences/libgsm.txt", + "https://fedoraproject.org/wiki/Licensing/Borceux", + "http://landley.net/toybox/license.html", + "https://github.com/ppp-project/ppp/blob/master/pppd/chap_ms.c#L6-L28", + "https://ctan.org/license/knuth", + "https://opensource.org/licenses/NOSL3.0", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=c9f95c2f3f2ffb5e0ae55fe7388af75547660941", + "https://fedoraproject.org/wiki/Licensing/Intel_ACPI_Software_License_Agreement", + "https://fedoraproject.org/wiki/Licensing/MIT#AdobeGlyph", + "https://fedoraproject.org/wiki/Licensing/BSD_with_Attribution", + "https://github.com/Dual-Life/mime-base64/blob/master/Base64.xs#L12", + "https://fedoraproject.org/wiki/Licensing/Zed", + "https://github.com/ppp-project/ppp/blob/master/modules/ppp_ahdlc.c#L7-L19", + "http://oss.sgi.com/projects/FreeB/SGIFreeSWLicB.1.0.html", + "https://fossies.org/linux/tiff/contrib/ras/ras2tif.c", + "http://research.scea.com/scea_shared_source_license.html", + "http://www.perlfoundation.org/artistic_license_2_0", + "http://source.icu-project.org/repos/icu/icu/trunk/license.html", + "https://creativecommons.org/licenses/by/2.5/legalcode", + "https://solderpad.org/licenses/SHL-0.51/", + "http://www.latex-project.org/lppl/lppl-1-3a.txt", + "https://cdla.io/permissive-1-0", + "http://www.eiffel-nice.org/license/eiffel-forum-license-2.html", + "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/converter/other/pnmtorle.c", + "https://gitlab.com/bacula-org/bacula/-/blob/Branch-11.0/bacula/LICENSE-FOSS?ref_type=heads#L245", + "https://fedoraproject.org/wiki/Licensing/AMD_plpa_map_License", + "https://fedoraproject.org/wiki/Licensing/Charter#License_Text", + "https://github.com/python-ldap/python-ldap/blob/main/LICENCE", + "https://creativecommons.org/licenses/by-sa/3.0/at/legalcode", + "https://www.ogc.org/ogc/software/1.0", + "https://creativecommons.org/licenses/by-sa/2.0/legalcode", + "https://git.openldap.org/openldap/openldap/-/blob/master/libraries/libldap/os-local.c?ref_type=heads#L19-23", + "https://opensource.apple.com/source/mDNSResponder/mDNSResponder-320.10/mDNSPosix/nss_ReadMe.txt", + "https://opensource.org/licenses/LPL-1.0", + "http://www.latex-project.org/lppl/lppl-1-1.txt", + "http://www.opensource.apple.com/cdl/", + "https://fedoraproject.org/wiki/Licensing:MIT#Another_Minimal_variant_(found_in_libatomic_ops)", + "https://github.com/ppp-project/ppp/blob/master/pppd/eap.c#L7-L16", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=4bc786f34b50aa301be6f5600f58a980070f481e", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=1cae062821881f41b73012ba816434897abf4205", + "http://download.oracle.com/otn-pub/java/licenses/bsd.txt", + "https://fedoraproject.org/wiki/Licensing/BSD_Protection_License", + "http://www.opencascade.com/content/occt-public-license", + "https://www.gnu.org/licenses/gpl-faq.html#FontException", + "http://www.zimbra.com/license/yahoo_public_license_1.0.html", + "https://sourceware.org/cgit/binutils-gdb/tree/include/coff/sym.h#n11", + "http://oss.sgi.com/projects/FreeB/SGIFreeSWLicB.2.0.pdf", + "https://gitlab.freedesktop.org/xorg/app/iceauth/-/blob/master/COPYING", + "https://fedoraproject.org/wiki/Licensing/Apple_MIT_License", + "https://opensource.org/licenses/OSL-1.0", + "https://sourceware.org/bzip2/1.0.5/bzip2-manual-1.0.5.html", + "https://www.mail-archive.com/debian-bugs-rc@lists.debian.org/msg11494.html", + "https://github.com/ruby/ruby/blob/9f6deaa6888a423720b4b127b5314f0ad26cc2e6/ext/pty/pty.c#L775-L786", + "https://github.com/Unidata/UDUNITS-2/blob/master/COPYRIGHT", + "https://opensource.org/licenses/SimPL-2.0", + "https://polyformproject.org/licenses/noncommercial/1.0.0", + "https://git.openldap.org/openldap/openldap/-/blob/master/COPYRIGHT?ref_type=heads#L39-51", + "https://github.com/ppp-project/ppp/blob/master/pppd/auth.c#L6-L28", + "https://creativecommons.org/publicdomain/mark/1.0/", + "http://www.zlib.net/zlib_license.html", + "https://web.archive.org/web/20060319014854/http://info.borland.com/devsupport/interbase/opensource/IPL.html", + "https://creativecommons.org/licenses/by-nc-sa/3.0/legalcode", + "https://fedoraproject.org/wiki/Licensing:MIT#Modern_Variants", + "http://web.archive.org/web/20140704074106/http://www.unicode.org/copyright.html", + "https://fedoraproject.org/wiki/Licensing/AdobePostscriptAFM", + "http://www.tcl.tk/software/tcltk/license.html", + "https://fedoraproject.org/wiki/Licensing/Xerox", + "https://fedoraproject.org/wiki/Licensing/FSF_Unlimited_License", + "https://git.savannah.gnu.org/cgit/wget.git/tree/util/trunc.c?h=v1.21.3&id=40747a11e44ced5a8ac628a41f879ced3e2ebce9#n6", + "http://www.imagemagick.org/script/license.php", + "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L140-L156", + "http://directory.fsf.org/wiki/License:BitTorrentOSL1.1", + "https://www.kernel.org/doc/man-pages/licenses.html", + "https://github.com/tytso/e2fsprogs/blob/master/lib/et/et_name.c", + "https://github.com/bagder/curl/blob/master/COPYING", + "https://fedoraproject.org/wiki/Licensing/MITNFA", + "https://fedoraproject.org/wiki/Licensing/libtiff", + "http://www.erlang.org/EPLICENSE", + "https://gitlab.freedesktop.org/xorg/font/adobe-utopia-100dpi/-/blob/master/COPYING?ref_type=heads", + "https://fedoraproject.org/wiki/Licensing/Haskell_Language_Report_License", + "https://www.isc.org/licenses/", + "https://opensource.org/licenses/Naumen", + "https://creativecommons.org/licenses/by-sa/1.0/legalcode", + "https://github.com/DISIC/politique-de-contribution-open-source/blob/master/LICENSE.pdf", + "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/converter/ppm/ppmtompeg/jrevdct.c#l1189", + "https://heasarc.gsfc.nasa.gov/docs/software/fitsio/c/f_user/node9.html", + "https://license.coscl.org.cn/MulanPSL/", + "https://opensource.org/licenses/BSDplusPatent", + "https://creativecommons.org/licenses/publicdomain/", + "https://fedoraproject.org/wiki/Licensing/TGPPL", + "https://github.com/openssh/openssh-portable/blob/master/openbsd-compat/bsd-snprintf.c#L2", + "https://fedoraproject.org/wiki/Licensing/Nunit", + "https://github.com/MariaDB/server/blob/11.6/libmysqld/lib_sql.cc", + "https://github.com/PixarAnimationStudios/OpenSubdiv/raw/v3_5_0/LICENSE.txt", + "http://www.netlib.org/minpack/disclaimer", + "https://github.com/ppp-project/ppp/blob/master/pppd/ipv6cp.c#L75-L83", + "https://fedoraproject.org/wiki/Licensing/App-s2p", + "https://github.com/acpica/acpica/blob/master/source/common/acfileio.c#L119", + "http://www.opengroup.org/testing/downloads/The_Open_Group_TSL.txt", + "http://www.opendatacommons.org/licenses/odbl/1.0/", + "https://creativecommons.org/licenses/by-nd/3.0/legalcode", + "https://creativecommons.org/licenses/by-sa/2.5/legalcode", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=47c2415c1df81556eeb39be6cad458ef87c534a2", + "https://opensource.org/licenses/UCL-1.0", + "https://fedoraproject.org/wiki/Licensing/Matrix_Template_Library_License", + "https://github.com/krb5/krb5/blob/krb5-1.21.2-final/NOTICE#L111-L133", + "http://old.zope.org/Resources/License/ZPL-2.0", + "https://github.com/bcrypt-ruby/bcrypt-ruby/blob/master/ext/mri/crypt_blowfish.c", + "https://creativecommons.org/licenses/by-nc-sa/3.0/de/legalcode", + "https://creativecommons.org/licenses/by-sa/3.0/igo/legalcode", + "http://apache.org/licenses/LICENSE-1.1", + "http://ac-archive.sourceforge.net/doc/copyright.html", + "https://github.com/apache/apr/blob/trunk/LICENSE#L298C6-L298C29", + "https://www.mongodb.com/licensing/server-side-public-license", + "https://github.com/SigmaHQ/Detection-Rule-License/blob/6ec7fbde6101d101b5b5d1fcb8f9b69fbc76c04a/LICENSE.Detection.Rules.md", + "https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/man2/move_pages.2#n5", + "http://www.openldap.org/devel/gitweb.cgi?p=openldap.git;a=blob;f=LICENSE;hb=b6d68acd14e51ca3aab4428bf26522aa74873f0e", + "https://cdla.dev/permissive-2-0", + "https://github.com/signal11/hidapi/blob/master/LICENSE-orig.txt", + "https://sourceware.org/git/?p=bzip2.git;a=blob;f=LICENSE;hb=bzip2-1.0.6", + "http://www.geuz.org/gl2ps/COPYING.GL2PS", + "https://fedoraproject.org/wiki/Licensing/TOSL", + "https://fedoraproject.org/wiki/Licensing/Abstyles", + "https://github.com/jonathanstowe/TermReadKey/blob/master/README#L9-L10", + "https://metadata.ftp-master.debian.org/changelogs//main/x/xzoom/xzoom_0.3-27_copyright", + "http://www.postgresql.org/about/licence", + "http://www.python.org/download/releases/1.6.1/download_win/", + "https://github.com/novnc/noVNC/blob/master/core/crypto/des.js#L24", + "https://gitlab.freedesktop.org/xorg/xserver/-/blob/master/COPYING?ref_type=heads#L1781", + "https://creativecommons.org/licenses/by-nc-sa/1.0/legalcode", + "https://metacpan.org/release/DPARIS/Crypt-Blowfish-2.14/source/COPYRIGHT#L7", + "http://www.latex-project.org/lppl/lppl-1-0.txt", + "http://www.zimbra.com/license/yahoo_public_license_1.1.html", + "https://fedoraproject.org/wiki/Licensing/SWL", + "http://liballeg.org/license.html#allegro-4-the-giftware-license", + "http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html", + "http://www.osetfoundation.org/public-license", + "https://www.gnu.org/licenses/autoconf-exception-3.0.html", + "https://github.com/sigmavirus24/x11-ssh-askpass/blob/master/dynlist.c", + "http://www.json.org/license.html", + "https://github.com/pkgconf/pkgconf/blob/master/cli/main.c#L8", + "http://www.php.net/license/3_01.txt", + "https://www.sqlite.org/src/artifact/e33a4df7e32d742a?ln=4-9", + "https://helixcommunity.org/content/rpsl", + "http://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo-x86/licenses/BitTorrent?r1=1.1&r2=1.1.1.1&diff_format=s", + "http://gridscheduler.sourceforge.net/Gridengine_SISSL_license.html", + "http://dev.w3.org/cvsweb/Amaya/libjpeg/Attic/README?rev=1.2", + "https://open.canada.ca/en/open-government-licence-canada", + "https://creativecommons.org/licenses/by-nd/2.5/legalcode", + "https://sourceforge.net/p/netpbm/code/HEAD/tree/super_stable/netpbm.c#l8", + "https://creativecommons.org/licenses/by-nc-nd/3.0/de/legalcode", + "https://opensource.org/licenses/RPL-1.5", + "https://opensource.org/licenses/nokia", + "https://gitlab.freedesktop.org/xorg/lib/libxtst/-/blob/master/COPYING?ref_type=heads#L108-117" + ], + "description": "Known license SPDX URLs.\n\nSPDX License List from spdx-license-list npm package Imported here as const to provide richer types for the License type.", + "markdownDescription": "Known license SPDX URLs.\n\nSPDX License List from spdx-license-list npm package\nImported here as const to provide richer types for the License type." + }, + "Server": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - url } |", + "markdownDescription": "A URL to the target host. This URL supports Server Variables and MAY be relative,\nto indicate that the host location is relative to the location where the OpenAPI\ndocument is being served. Variable substitutions will be made when a variable\nis named in {brackets}.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - url } |", + "examples": [ + "https://api.example.com/v1", + "https://{username}.example.com:{port}/{basePath}", + "/v1" + ] + }, + "description": { + "type": "string", + "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", + "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", + "examples": ["Development server", "Production server"] + }, + "variables": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ServerVariable" + }, + "description": "A map between a variable name and its value. The value is used for substitution in the server's URL template.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - variables } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - variables } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - variables } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - variables } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - variables } |", + "markdownDescription": "A map between a variable name and its value. The value is used for substitution\nin the server's URL template.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - variables } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - variables } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - variables } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - variables } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - variables } |", + "examples": [ + { + "username": { + "default": "demo" + }, + "port": { + "default": "8080" + } + } + ] + } + }, + "required": ["url"], + "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" + }, + "ServerVariable": { + "type": "object", + "properties": { + "enum": { + "type": "array", + "items": { + "type": "string" + }, + "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", + "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", + "examples": [ + ["8443", "443"], + ["v1", "v2", "v3"] + ] + }, + "default": { + "type": "string", + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", + "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", + "examples": ["demo", "8443", "v2"] + }, + "description": { + "type": "string", + "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - description } |", + "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - description } |", + "examples": [ + "this value is assigned by the service provider", + "Port number for the server" + ] + } + }, + "required": ["default"], + "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" + }, + "Paths": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/PathItem" + }, + {} + ] + }, + "properties": {}, + "description": "----- Paths Object\n-----\n\nHolds the relative paths to the individual endpoints and their operations.\n\nThe Paths Object holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths MAY be empty, due to ACL constraints.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#paths-object OpenAPI 3.0.4 Paths } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#paths-object OpenAPI 3.0.3 Paths } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#paths-object OpenAPI 3.0.2 Paths } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#paths-object OpenAPI 3.0.1 Paths } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#paths-object OpenAPI 3.0.0 Paths } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nPaths Object\n-----\n\nHolds the relative paths to the individual endpoints and their operations.\n\nThe Paths Object holds the relative paths to the individual endpoints and their operations.\nThe path is appended to the URL from the Server Object in order to construct the full URL.\nThe Paths MAY be empty, due to ACL constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#paths-object OpenAPI 3.0.4 Paths } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#paths-object OpenAPI 3.0.3 Paths } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#paths-object OpenAPI 3.0.2 Paths } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#paths-object OpenAPI 3.0.1 Paths } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#paths-object OpenAPI 3.0.0 Paths } |\n\n-----\nFields\n-----" + }, + "PathItem": { + "anyOf": [ + { + "type": "object", + "properties": { + "$ref": { + "type": "string", + "description": "Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - $ref } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - $ref } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - $ref } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - $ref } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - $ref } |", + "markdownDescription": "Allows for an external definition of this path item. The referenced structure\nMUST be in the format of a Path Item Object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - $ref } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - $ref } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - $ref } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - $ref } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - $ref } |" + }, + "summary": { + "type": "string", + "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", + "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", + "examples": ["User management operations"] + }, + "description": { + "type": "string", + "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", + "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", + "examples": ["Operations for managing users in the system"] + }, + "get": { + "$ref": "#/definitions/Operation", + "description": "A definition of a GET operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - get } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - get } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - get } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - get } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - get } |", + "markdownDescription": "A definition of a GET operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - get } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - get } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - get } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - get } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - get } |", + "examples": [ + { + "summary": "Get users", + "responses": { + "200": { + "description": "Success" + } + } + } + ] + }, + "put": { + "$ref": "#/definitions/Operation", + "description": "A definition of a PUT operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - put } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - put } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - put } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - put } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - put } |", + "markdownDescription": "A definition of a PUT operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - put } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - put } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - put } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - put } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - put } |", + "examples": [ + { + "summary": "Update user", + "responses": { + "200": { + "description": "Success" + } + } + } + ] + }, + "post": { + "$ref": "#/definitions/Operation", + "description": "A definition of a POST operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - post } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - post } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - post } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - post } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - post } |", + "markdownDescription": "A definition of a POST operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - post } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - post } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - post } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - post } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - post } |", + "examples": [ + { + "summary": "Create user", + "responses": { + "201": { + "description": "Created" + } + } + } + ] + }, + "delete": { + "$ref": "#/definitions/Operation", + "description": "A definition of a DELETE operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - delete } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - delete } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - delete } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - delete } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - delete } |", + "markdownDescription": "A definition of a DELETE operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - delete } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - delete } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - delete } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - delete } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - delete } |", + "examples": [ + { + "summary": "Delete user", + "responses": { + "204": { + "description": "No Content" + } + } + } + ] + }, + "options": { + "$ref": "#/definitions/Operation", + "description": "A definition of an OPTIONS operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - options } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - options } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - options } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - options } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - options } |", + "markdownDescription": "A definition of an OPTIONS operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - options } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - options } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - options } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - options } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - options } |", + "examples": [ + { + "summary": "Get options", + "responses": { + "200": { + "description": "Options" + } + } + } + ] + }, + "head": { + "$ref": "#/definitions/Operation", + "description": "A definition of a HEAD operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - head } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - head } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - head } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - head } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - head } |", + "markdownDescription": "A definition of a HEAD operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - head } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - head } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - head } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - head } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - head } |", + "examples": [ + { + "summary": "Check if resource exists", + "responses": { + "200": { + "description": "Exists" + } + } + } + ] + }, + "patch": { + "$ref": "#/definitions/Operation", + "description": "A definition of a PATCH operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - patch } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - patch } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - patch } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - patch } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - patch } |", + "markdownDescription": "A definition of a PATCH operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - patch } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - patch } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - patch } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - patch } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - patch } |", + "examples": [ + { + "summary": "Partially update user", + "responses": { + "200": { + "description": "Success" + } + } + } + ] + }, + "trace": { + "$ref": "#/definitions/Operation", + "description": "A definition of a TRACE operation on this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - trace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - trace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - trace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - trace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - trace } |", + "markdownDescription": "A definition of a TRACE operation on this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - trace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - trace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - trace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - trace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - trace } |", + "examples": [ + { + "summary": "Trace request", + "responses": { + "200": { + "description": "Success" + } + } + } + ] + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "An alternative server array to service all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - servers } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - servers } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - servers } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - servers } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - servers } |", + "markdownDescription": "An alternative server array to service all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - servers } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - servers } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - servers } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - servers } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - servers } |", + "examples": [ + [ + { + "url": "https://api.example.com/v1" + } + ] + ] + }, + "parameters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/definitions/Parameter" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - parameters } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - parameters } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - parameters } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - parameters } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - parameters } |", + "markdownDescription": "A list of parameters that are applicable for all the operations described\nunder this path. These parameters can be overridden at the operation level,\nbut cannot be removed there. The list MUST NOT include duplicated parameters.\nA unique parameter is defined by a combination of a name and location.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - parameters } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - parameters } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - parameters } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - parameters } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - parameters } |", + "examples": [ + [ + { + "name": "limit", + "in": "query", + "schema": { + "type": "integer" + } + } + ] + ] + } + } + }, + { + "$ref": "#/definitions/Reference" + } + ], + "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints.\n\nThe Path Item Object describes the operations available on a single path. It can contain a summary and description that apply to all operations on the path, as well as individual operation definitions for each HTTP method.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path.\nA Path Item MAY be empty, due to ACL constraints.\n\nThe Path Item Object describes the operations available on a single path. It can\ncontain a summary and description that apply to all operations on the path, as well\nas individual operation definitions for each HTTP method.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item } |\n\n-----\nFields\n-----" + }, + "Operation": { + "type": "object", + "properties": { + "tags": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", + "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", + "examples": [["users", "authentication"], ["pets"]] + }, + "summary": { + "type": "string", + "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", + "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", + "examples": ["Get user by ID", "Create a new pet"] + }, + "description": { + "type": "string", + "description": "A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - description } |", + "markdownDescription": "A verbose explanation of the operation behavior. CommonMark syntax MAY be used\nfor rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - description } |", + "examples": [ + "Retrieves a specific user by their unique identifier. Returns user details including name, email, and profile information." + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for this operation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - externalDocs } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - externalDocs } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - externalDocs } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - externalDocs } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - externalDocs } |", + "markdownDescription": "Additional external documentation for this operation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - externalDocs } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - externalDocs } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - externalDocs } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - externalDocs } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - externalDocs } |", + "examples": [ + { + "description": "Find out more about this operation", + "url": "https://example.com/docs" + } + ] + }, + "operationId": { + "type": "string", + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", + "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", + "examples": ["getUserById", "createPet"] + }, + "parameters": { + "type": "array", + "items": { + "anyOf": [ + { + "$ref": "#/definitions/Parameter" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - parameters } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - parameters } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - parameters } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - parameters } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - parameters } |", + "markdownDescription": "A list of parameters that are applicable for this operation. If a parameter\nis already defined at the Path Item, the new definition will override it\nbut can never remove it. The list MUST NOT include duplicated parameters.\nA unique parameter is defined by a combination of a name and location.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - parameters } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - parameters } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - parameters } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - parameters } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - parameters } |", + "examples": [ + [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ] + ] + }, + "requestBody": { + "anyOf": [ + { + "$ref": "#/definitions/RequestBody" + }, + { + "$ref": "#/definitions/Reference" + } + ], + "description": "The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification has explicitly defined semantics for request bodies.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - requestBody } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - requestBody } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - requestBody } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - requestBody } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - requestBody } |", + "markdownDescription": "The request body applicable for this operation. The requestBody is only\nsupported in HTTP methods where the HTTP 1.1 specification has explicitly\ndefined semantics for request bodies.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - requestBody } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - requestBody } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - requestBody } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - requestBody } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - requestBody } |", + "examples": [ + { + "description": "User data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + ] + }, + "responses": { + "$ref": "#/definitions/ResponsesMap", + "description": "The list of possible responses as they are returned from executing this operation. This field MUST be present and MUST contain at least one response.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - responses } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - responses } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - responses } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - responses } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - responses } |", + "markdownDescription": "The list of possible responses as they are returned from executing this operation.\nThis field MUST be present and MUST contain at least one response.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - responses } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - responses } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - responses } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - responses } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - responses } |", + "examples": [ + { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + } + ] + }, + "callbacks": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Callback" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "A map of possible out-of band callbacks related to the parent operation. 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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - callbacks } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - callbacks } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - callbacks } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - callbacks } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - callbacks } |", + "markdownDescription": "A map of possible out-of band callbacks related to the parent operation.\nThe key is a unique identifier for the Callback Object. Each value in the map\nis a Callback Object that describes a request that may be initiated by the API\nprovider and the expected responses.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - callbacks } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - callbacks } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - callbacks } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - callbacks } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - callbacks } |" + }, + "deprecated": { + "type": "boolean", + "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", + "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", + "examples": [true], + "default": false + }, + "security": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRequirement" + }, + "description": "A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level security.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - security } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - security } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - security } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - security } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - security } |", + "markdownDescription": "A declaration of which security mechanisms can be used for this operation.\nThe list of values includes alternative security requirement objects that can be used.\nOnly one of the security requirement objects need to be satisfied to authorize a request.\nThis definition overrides any declared top-level security.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - security } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - security } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - security } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - security } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - security } |", + "examples": [ + [ + { + "api_key": [] + } + ], + [ + { + "oauth2": ["read", "write"] + } + ] + ] + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/Server" + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - servers } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - servers } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - servers } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - servers } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - servers } |", + "markdownDescription": "An alternative server array to service this operation. If an alternative\nserver object is specified at the Path Item Object or Root level, it will\nbe overridden by this value.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - servers } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - servers } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - servers } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - servers } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - servers } |", + "examples": [ + [ + { + "url": "https://api.example.com/v1" + } + ] + ] + } + }, + "required": ["responses"], + "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" + }, + "ExternalDocumentation": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", + "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", + "examples": ["Find more info here", "Additional documentation for this API"] + }, + "url": { + "type": "string", + "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", + "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] + } + }, + "required": ["url"], + "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" + }, + "Parameter": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", + "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", + "examples": ["id", "limit", "user"] + }, + "in": { + "type": "string", + "enum": ["query", "header", "path", "cookie"], + "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", + "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", + "examples": ["query", "path", "header", "cookie"] + }, + "description": { + "type": "string", + "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", + "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", + "examples": ["User ID to retrieve", "Number of items to return"] + }, + "required": { + "type": "boolean", + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", + "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", + "examples": [true, false] + }, + "deprecated": { + "type": "boolean", + "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", + "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", + "examples": [true, false] + }, + "allowEmptyValue": { + "type": "boolean", + "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", + "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", + "examples": [true, false] + }, + "style": { + "type": "string", + "enum": [ + "matrix", + "label", + "form", + "simple", + "spaceDelimited", + "pipeDelimited", + "deepObject" + ], + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - style } |", + "markdownDescription": "Describes how the parameter value will be serialized depending on the type of the parameter value.\nDefault values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - style } |", + "examples": [ + "form", + "simple", + "matrix", + "label", + "spaceDelimited", + "pipeDelimited", + "deepObject" + ] + }, + "explode": { + "type": "boolean", + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", + "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", + "examples": [true, false] + }, + "allowReserved": { + "type": "boolean", + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", + "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", + "examples": [true, false] + }, + "schema": { + "$ref": "#/definitions/Schema", + "description": "The schema defining the type used for the parameter.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - schema } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - schema } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - schema } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - schema } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - schema } |", + "markdownDescription": "The schema defining the type used for the parameter.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - schema } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - schema } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - schema } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - schema } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - schema } |", + "examples": [ + { + "type": "string" + }, + { + "type": "integer", + "minimum": 1, + "maximum": 100 + } + ] + }, + "example": { + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", + "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", + "examples": ["example-value", 42] + }, + "examples": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Example" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - examples } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - examples } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - examples } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - examples } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - examples } |", + "markdownDescription": "Examples of the media type. Each example SHOULD contain a value in the correct format\nas specified in the parameter encoding. The examples object is mutually exclusive of\nthe example object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - examples } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - examples } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - examples } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - examples } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - examples } |", + "examples": [ + { + "user1": { + "summary": "A user example", + "value": "user123" + } + } + ] + }, + "content": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MediaType" + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - content } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - content } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - content } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - content } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - content } |", + "markdownDescription": "A map containing the representations for the parameter. The key is the media type\nand the value describes it. The map MUST only contain one entry.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - content } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - content } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - content } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - content } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - content } |", + "examples": [ + { + "application/json": { + "schema": { + "type": "object" + } + } + } + ] + } + }, + "required": ["name", "in"], + "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" + }, + "Schema": { + "anyOf": [ + { + "$ref": "#/definitions/ReferenceSchema" + }, + { + "$ref": "#/definitions/StringSchema" + }, + { + "$ref": "#/definitions/NumberSchema" + }, + { + "$ref": "#/definitions/IntegerSchema" + }, + { + "$ref": "#/definitions/BooleanSchema" + }, + { + "$ref": "#/definitions/ArraySchema" + }, + { + "$ref": "#/definitions/ObjectSchema" + }, + { + "$ref": "#/definitions/CompositionSchema" + } + ], + "description": "----- Schema Object (OpenAPI 3.0.x)\n-----\n\nThe Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is based on JSON Schema Specification Draft 7 and uses the same formatting rules.\n\nThis discriminated union enforces the OpenAPI 3.0.x mutual-exclusion and co-occurrence rules, ensuring that only valid combinations of properties can be used together.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Schema Types\n-----", + "markdownDescription": "-----\nSchema Object (OpenAPI 3.0.x)\n-----\n\nThe Schema Object allows the definition of input and output data types.\nThese types can be objects, but also primitives and arrays. This object\nis based on JSON Schema Specification Draft 7 and uses the same\nformatting rules.\n\nThis discriminated union enforces the OpenAPI 3.0.x mutual-exclusion and\nco-occurrence rules, ensuring that only valid combinations of properties\ncan be used together.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nSchema Types\n-----" + }, + "ReferenceSchema": { + "type": "object", + "properties": { + "$ref": { + "type": "string", + "description": "The reference string. MUST be a valid JSON Reference.", + "markdownDescription": "The reference string. MUST be a valid JSON Reference.", + "examples": [ + "#/components/schemas/User", + "#/components/responses/NotFound", + "#/components/parameters/LimitParam" + ] + }, + "description": { + "type": "string", + "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", + "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", + "examples": ["A reference to the User schema", "Pet object definition"] + } + }, + "required": ["$ref"], + "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" + }, + "StringSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "string", + "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", + "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", + "examples": ["string"] + }, + "format": { + "type": "string", + "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", + "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", + "examples": ["email", "date", "uuid", "uri"] + }, + "title": { + "type": "string", + "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", + "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", + "examples": ["User Name", "Email Address"] + }, + "description": { + "type": "string", + "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", + "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", + "examples": ["The user's full name", "Email address in RFC 5322 format"] + }, + "default": { + "type": "string", + "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", + "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", + "examples": ["John Doe", "user@example.com"] + }, + "example": { + "type": "string", + "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", + "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", + "examples": ["Jane Smith", "admin@example.com"] + }, + "enum": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", + "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", + "examples": [ + ["active", "inactive", "pending"], + ["red", "green", "blue"] + ] + }, + "readOnly": { + "type": "boolean", + "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", + "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", + "examples": [true], + "default": false + }, + "writeOnly": { + "type": "boolean", + "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", + "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", + "examples": [true], + "default": false + }, + "xml": { + "$ref": "#/definitions/XML", + "description": "XML representation metadata for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - xml } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - xml } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - xml } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - xml } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - xml } |", + "markdownDescription": "XML representation metadata for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - xml } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - xml } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - xml } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - xml } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - xml } |", + "examples": [ + { + "name": "userName", + "attribute": false + } + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - externalDocs } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - externalDocs } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - externalDocs } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - externalDocs } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - externalDocs } |", + "markdownDescription": "Additional external documentation for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - externalDocs } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - externalDocs } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - externalDocs } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - externalDocs } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - externalDocs } |", + "examples": [ + { + "description": "Find out more about this field", + "url": "https://example.com/docs" + } + ] + }, + "deprecated": { + "type": "boolean", + "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", + "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", + "examples": [true], + "default": false + }, + "maxLength": { + "type": "number", + "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", + "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", + "examples": [100, 255] + }, + "minLength": { + "type": "number", + "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", + "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", + "examples": [1, 8] + }, + "pattern": { + "type": "string", + "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", + "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] + } + }, + "required": ["type"], + "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" + }, + "XML": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", + "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", + "examples": ["animal", "item"] + }, + "namespace": { + "type": "string", + "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", + "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] + }, + "prefix": { + "type": "string", + "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", + "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", + "examples": ["xs", "ns"] + }, + "attribute": { + "type": "boolean", + "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", + "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", + "examples": [true, false] + }, + "wrapped": { + "type": "boolean", + "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", + "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", + "examples": [true, false] + } + }, + "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the name property should be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n-----\nFields\n-----" + }, + "NumberSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "number", + "description": "The type of the schema. Must be \"number\" for number schemas.", + "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", + "examples": ["number"] + }, + "format": { + "type": "string", + "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", + "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", + "examples": ["float", "double"] + }, + "title": { + "type": "string", + "description": "A short title for the schema.", + "markdownDescription": "A short title for the schema.", + "examples": ["Price", "Temperature"] + }, + "description": { + "type": "string", + "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "examples": ["The price in dollars", "Temperature in Celsius"] + }, + "default": { + "type": "number", + "description": "The default value for the schema.", + "markdownDescription": "The default value for the schema.", + "examples": [0, 25.5] + }, + "example": { + "type": "number", + "description": "Example value for the schema.", + "markdownDescription": "Example value for the schema.", + "examples": [19.99, 98.6] + }, + "enum": { + "type": "array", + "items": { + "type": "number" + }, + "description": "Enumeration of valid number values.", + "markdownDescription": "Enumeration of valid number values.", + "examples": [ + [1, 2, 3, 4, 5], + [0, 0.5, 1] + ] + }, + "readOnly": { + "type": "boolean", + "description": "Whether the property is read-only. Default value is false.", + "markdownDescription": "Whether the property is read-only. Default value is false.", + "examples": [true], + "default": false + }, + "writeOnly": { + "type": "boolean", + "description": "Whether the property is write-only. Default value is false.", + "markdownDescription": "Whether the property is write-only. Default value is false.", + "examples": [true], + "default": false + }, + "xml": { + "$ref": "#/definitions/XML", + "description": "XML representation metadata for the schema.", + "markdownDescription": "XML representation metadata for the schema.", + "examples": [ + { + "name": "price", + "attribute": true + } + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for the schema.", + "markdownDescription": "Additional external documentation for the schema.", + "examples": [ + { + "description": "Find out more about this field", + "url": "https://example.com/docs" + } + ] + }, + "deprecated": { + "type": "boolean", + "description": "Whether the schema is deprecated. Default value is false.", + "markdownDescription": "Whether the schema is deprecated. Default value is false.", + "examples": [true], + "default": false + }, + "multipleOf": { + "type": "number", + "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", + "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", + "examples": [0.01, 0.1, 2] + }, + "maximum": { + "type": "number", + "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", + "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", + "examples": [100, 999.99] + }, + "exclusiveMaximum": { + "type": "number", + "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", + "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", + "examples": [100, 1000] + }, + "minimum": { + "type": "number", + "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", + "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", + "examples": [0, -273.15] + }, + "exclusiveMinimum": { + "type": "number", + "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", + "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", + "examples": [0, -100] + } + }, + "required": ["type"], + "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" + }, + "IntegerSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "integer", + "description": "The type of the schema. Must be \"integer\" for integer schemas.", + "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", + "examples": ["integer"] + }, + "format": { + "type": "string", + "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", + "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", + "examples": ["int32", "int64"] + }, + "title": { + "type": "string", + "description": "A short title for the schema.", + "markdownDescription": "A short title for the schema.", + "examples": ["User ID", "Age"] + }, + "description": { + "type": "string", + "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "examples": ["The user's unique identifier", "Age in years"] + }, + "default": { + "type": "number", + "description": "The default value for the schema.", + "markdownDescription": "The default value for the schema.", + "examples": [0, 1] + }, + "example": { + "type": "number", + "description": "Example value for the schema.", + "markdownDescription": "Example value for the schema.", + "examples": [42, 100] + }, + "enum": { + "type": "array", + "items": { + "type": "number" + }, + "description": "Enumeration of valid integer values.", + "markdownDescription": "Enumeration of valid integer values.", + "examples": [ + [1, 2, 3, 4, 5], + [0, 1, 2] + ] + }, + "readOnly": { + "type": "boolean", + "description": "Whether the property is read-only. Default value is false.", + "markdownDescription": "Whether the property is read-only. Default value is false.", + "examples": [true], + "default": false + }, + "writeOnly": { + "type": "boolean", + "description": "Whether the property is write-only. Default value is false.", + "markdownDescription": "Whether the property is write-only. Default value is false.", + "examples": [true], + "default": false + }, + "xml": { + "$ref": "#/definitions/XML", + "description": "XML representation metadata for the schema.", + "markdownDescription": "XML representation metadata for the schema.", + "examples": [ + { + "name": "userId", + "attribute": true + } + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for the schema.", + "markdownDescription": "Additional external documentation for the schema.", + "examples": [ + { + "description": "Find out more about this field", + "url": "https://example.com/docs" + } + ] + }, + "deprecated": { + "type": "boolean", + "description": "Whether the schema is deprecated. Default value is false.", + "markdownDescription": "Whether the schema is deprecated. Default value is false.", + "examples": [true], + "default": false + }, + "multipleOf": { + "type": "number", + "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", + "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", + "examples": [1, 2, 5] + }, + "maximum": { + "type": "number", + "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", + "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", + "examples": [100, 2147483647] + }, + "exclusiveMaximum": { + "type": "number", + "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", + "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", + "examples": [100, 1000] + }, + "minimum": { + "type": "number", + "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", + "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", + "examples": [0, 1] + }, + "exclusiveMinimum": { + "type": "number", + "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", + "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", + "examples": [0, -1] + } + }, + "required": ["type"], + "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" + }, + "BooleanSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "boolean", + "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", + "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", + "examples": ["boolean"] + }, + "title": { + "type": "string", + "description": "A short title for the schema.", + "markdownDescription": "A short title for the schema.", + "examples": ["Is Active", "Enabled"] + }, + "description": { + "type": "string", + "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "examples": ["Whether the user is active", "Feature enabled status"] + }, + "default": { + "type": "boolean", + "description": "The default value for the schema.", + "markdownDescription": "The default value for the schema.", + "examples": [true, false] + }, + "example": { + "type": "boolean", + "description": "Example value for the schema.", + "markdownDescription": "Example value for the schema.", + "examples": [true, false] + }, + "enum": { + "type": "array", + "items": { + "type": "boolean" + }, + "description": "Enumeration of valid boolean values.", + "markdownDescription": "Enumeration of valid boolean values.", + "examples": [[true, false]] + }, + "readOnly": { + "type": "boolean", + "description": "Whether the property is read-only. Default value is false.", + "markdownDescription": "Whether the property is read-only. Default value is false.", + "examples": [true], + "default": false + }, + "writeOnly": { + "type": "boolean", + "description": "Whether the property is write-only. Default value is false.", + "markdownDescription": "Whether the property is write-only. Default value is false.", + "examples": [true], + "default": false + }, + "xml": { + "$ref": "#/definitions/XML", + "description": "XML representation metadata for the schema.", + "markdownDescription": "XML representation metadata for the schema.", + "examples": [ + { + "name": "isActive", + "attribute": true + } + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for the schema.", + "markdownDescription": "Additional external documentation for the schema.", + "examples": [ + { + "description": "Find out more about this field", + "url": "https://example.com/docs" + } + ] + }, + "deprecated": { + "type": "boolean", + "description": "Whether the schema is deprecated. Default value is false.", + "markdownDescription": "Whether the schema is deprecated. Default value is false.", + "examples": [true], + "default": false + } + }, + "required": ["type"], + "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" + }, + "ArraySchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "array", + "description": "The type of the schema. Must be \"array\" for array schemas.", + "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", + "examples": ["array"] + }, + "title": { + "type": "string", + "description": "A short title for the schema.", + "markdownDescription": "A short title for the schema.", + "examples": ["Tags", "User List"] + }, + "description": { + "type": "string", + "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "examples": ["Array of tag strings", "List of user objects"] + }, + "default": { + "type": "array", + "items": {}, + "description": "The default value for the schema.", + "markdownDescription": "The default value for the schema.", + "examples": [["tag1", "tag2"], []] + }, + "example": { + "type": "array", + "items": {}, + "description": "Example value for the schema.", + "markdownDescription": "Example value for the schema.", + "examples": [ + ["example1", "example2"], + [1, 2, 3] + ] + }, + "enum": { + "type": "array", + "items": { + "type": "array", + "items": {} + }, + "description": "Enumeration of valid array values.", + "markdownDescription": "Enumeration of valid array values.", + "examples": [ + [ + ["a", "b"], + ["c", "d"] + ], + [ + [1, 2], + [3, 4] + ] + ] + }, + "readOnly": { + "type": "boolean", + "description": "Whether the property is read-only. Default value is false.", + "markdownDescription": "Whether the property is read-only. Default value is false.", + "examples": [true], + "default": false + }, + "writeOnly": { + "type": "boolean", + "description": "Whether the property is write-only. Default value is false.", + "markdownDescription": "Whether the property is write-only. Default value is false.", + "examples": [true], + "default": false + }, + "xml": { + "$ref": "#/definitions/XML", + "description": "XML representation metadata for the schema.", + "markdownDescription": "XML representation metadata for the schema.", + "examples": [ + { + "name": "tags", + "wrapped": true + } + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for the schema.", + "markdownDescription": "Additional external documentation for the schema.", + "examples": [ + { + "description": "Find out more about this field", + "url": "https://example.com/docs" + } + ] + }, + "deprecated": { + "type": "boolean", + "description": "Whether the schema is deprecated. Default value is false.", + "markdownDescription": "Whether the schema is deprecated. Default value is false.", + "examples": [true], + "default": false + }, + "items": { + "$ref": "#/definitions/Schema", + "description": "Schema for the items in the array. This field is required for array schemas.", + "markdownDescription": "Schema for the items in the array. This field is required for array schemas.", + "examples": [ + { + "type": "string" + }, + { + "$ref": "#/components/schemas/User" + } + ] + }, + "maxItems": { + "type": "number", + "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", + "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", + "examples": [10, 100] + }, + "minItems": { + "type": "number", + "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", + "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", + "examples": [1, 0] + }, + "uniqueItems": { + "type": "boolean", + "description": "Whether all items in the array must be unique. Default value is false.", + "markdownDescription": "Whether all items in the array must be unique. Default value is false.", + "examples": [true], + "default": false + } + }, + "required": ["type"], + "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" + }, + "ObjectSchema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "object", + "description": "The type of the schema. Must be \"object\" for object schemas.", + "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", + "examples": ["object"] + }, + "title": { + "type": "string", + "description": "A short title for the schema.", + "markdownDescription": "A short title for the schema.", + "examples": ["User", "Product"] + }, + "description": { + "type": "string", + "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "examples": [ + "A user object containing basic information", + "Product information with pricing" + ] + }, + "default": { + "type": "object", + "additionalProperties": {}, + "description": "The default value for the schema.", + "markdownDescription": "The default value for the schema.", + "examples": [ + { + "name": "John", + "age": 30 + }, + {} + ] + }, + "example": { + "type": "object", + "additionalProperties": {}, + "description": "Example value for the schema.", + "markdownDescription": "Example value for the schema.", + "examples": [ + { + "name": "Jane", + "age": 25 + }, + { + "id": 1, + "title": "Sample" + } + ] + }, + "enum": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": {} + }, + "description": "Enumeration of valid object values.", + "markdownDescription": "Enumeration of valid object values.", + "examples": [ + [ + { + "name": "John" + }, + { + "name": "Jane" + } + ], + [ + { + "status": "active" + }, + { + "status": "inactive" + } + ] + ] + }, + "readOnly": { + "type": "boolean", + "description": "Whether the property is read-only. Default value is false.", + "markdownDescription": "Whether the property is read-only. Default value is false.", + "examples": [true], + "default": false + }, + "writeOnly": { + "type": "boolean", + "description": "Whether the property is write-only. Default value is false.", + "markdownDescription": "Whether the property is write-only. Default value is false.", + "examples": [true], + "default": false + }, + "xml": { + "$ref": "#/definitions/XML", + "description": "XML representation metadata for the schema.", + "markdownDescription": "XML representation metadata for the schema.", + "examples": [ + { + "name": "user", + "wrapped": false + } + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for the schema.", + "markdownDescription": "Additional external documentation for the schema.", + "examples": [ + { + "description": "Find out more about this object", + "url": "https://example.com/docs" + } + ] + }, + "deprecated": { + "type": "boolean", + "description": "Whether the schema is deprecated. Default value is false.", + "markdownDescription": "Whether the schema is deprecated. Default value is false.", + "examples": [true], + "default": false + }, + "discriminator": { + "$ref": "#/definitions/Discriminator", + "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", + "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", + "examples": ["petType", "type"] + }, + "properties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Schema" + }, + "description": "Properties of the object. Each property name maps to a schema definition.", + "markdownDescription": "Properties of the object. Each property name maps to a schema definition.", + "examples": [ + { + "name": { + "type": "string" + }, + "age": { + "type": "integer" + } + }, + { + "id": { + "$ref": "#/components/schemas/Id" + } + } + ] + }, + "required": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of property names that are required. Properties not listed here are optional.", + "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", + "examples": [["id", "name"], ["email"]] + }, + "additionalProperties": { + "anyOf": [ + { + "type": "boolean" + }, + { + "$ref": "#/definitions/Schema" + } + ], + "description": "Schema for additional properties not defined in the properties object. Can be a boolean or a schema.", + "markdownDescription": "Schema for additional properties not defined in the properties object.\nCan be a boolean or a schema.", + "examples": [ + true, + false, + { + "type": "string" + } + ] + }, + "patternProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Schema" + }, + "description": "Pattern-based properties using regular expressions as keys.", + "markdownDescription": "Pattern-based properties using regular expressions as keys.", + "examples": [ + { + "^S_": { + "type": "string" + } + }, + { + "^[0-9]+$": { + "type": "integer" + } + } + ] + }, + "propertyNames": { + "$ref": "#/definitions/Schema", + "description": "Schema for property names. If present, property names must conform to this schema.", + "markdownDescription": "Schema for property names. If present, property names must conform to this schema.", + "examples": [ + { + "type": "string", + "pattern": "^[a-zA-Z][a-zA-Z0-9]*$" + } + ] + }, + "maxProperties": { + "type": "number", + "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", + "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", + "examples": [10, 50] + }, + "minProperties": { + "type": "number", + "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", + "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", + "examples": [1, 2] + } + }, + "required": ["type"], + "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" + }, + "Discriminator": { + "type": "object", + "properties": { + "propertyName": { + "type": "string", + "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", + "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", + "examples": ["petType", "type", "kind"] + }, + "mapping": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "An object to hold mappings between payload values and schema names or references.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - mapping } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - mapping } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - mapping } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - mapping } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - mapping } |", + "markdownDescription": "An object to hold mappings between payload values and schema names or references.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - mapping } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - mapping } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - mapping } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - mapping } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - mapping } |", + "examples": [ + { + "dog": "Dog", + "cat": "Cat" + }, + { + "admin": "AdminUser", + "user": "RegularUser" + } + ] + } + }, + "required": ["propertyName"], + "additionalProperties": false, + "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" + }, + "CompositionSchema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "A short title for the schema.", + "markdownDescription": "A short title for the schema.", + "examples": ["Composed User", "Flexible Value"] + }, + "description": { + "type": "string", + "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", + "examples": [ + "Schema composed from multiple base schemas", + "Value that can be string or number" + ] + }, + "default": { + "description": "The default value for the schema.", + "markdownDescription": "The default value for the schema.", + "examples": [ + "default value", + { + "name": "default" + } + ] + }, + "example": { + "description": "Example value for the schema.", + "markdownDescription": "Example value for the schema.", + "examples": [ + "example value", + { + "name": "example" + } + ] + }, + "enum": { + "type": "array", + "items": {}, + "description": "Enumeration of valid values.", + "markdownDescription": "Enumeration of valid values.", + "examples": [ + ["value1", "value2"], + [1, 2, 3] + ] + }, + "readOnly": { + "type": "boolean", + "description": "Whether the property is read-only. Default value is false.", + "markdownDescription": "Whether the property is read-only. Default value is false.", + "examples": [true], + "default": false + }, + "writeOnly": { + "type": "boolean", + "description": "Whether the property is write-only. Default value is false.", + "markdownDescription": "Whether the property is write-only. Default value is false.", + "examples": [true], + "default": false + }, + "xml": { + "$ref": "#/definitions/XML", + "description": "XML representation metadata for the schema.", + "markdownDescription": "XML representation metadata for the schema.", + "examples": [ + { + "name": "composed", + "wrapped": true + } + ] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for the schema.", + "markdownDescription": "Additional external documentation for the schema.", + "examples": [ + { + "description": "Find out more about this schema", + "url": "https://example.com/docs" + } + ] + }, + "deprecated": { + "type": "boolean", + "description": "Whether the schema is deprecated. Default value is false.", + "markdownDescription": "Whether the schema is deprecated. Default value is false.", + "examples": [true], + "default": false + }, + "discriminator": { + "$ref": "#/definitions/Discriminator", + "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", + "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", + "examples": ["petType", "type"] + }, + "allOf": { + "type": "array", + "items": { + "$ref": "#/definitions/Schema" + }, + "description": "Array of schemas that must all be valid for the instance to be valid.", + "markdownDescription": "Array of schemas that must all be valid for the instance to be valid.", + "examples": [ + [ + { + "$ref": "#/components/schemas/Base" + }, + { + "type": "object", + "required": ["id"] + } + ] + ] + }, + "anyOf": { + "type": "array", + "items": { + "$ref": "#/definitions/Schema" + }, + "description": "Array of schemas where at least one must be valid for the instance to be valid.", + "markdownDescription": "Array of schemas where at least one must be valid for the instance to be valid.", + "examples": [ + [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + ] + }, + "oneOf": { + "type": "array", + "items": { + "$ref": "#/definitions/Schema" + }, + "description": "Array of schemas where exactly one must be valid for the instance to be valid.", + "markdownDescription": "Array of schemas where exactly one must be valid for the instance to be valid.", + "examples": [ + [ + { + "$ref": "#/components/schemas/Dog" + }, + { + "$ref": "#/components/schemas/Cat" + } + ] + ] + }, + "not": { + "$ref": "#/definitions/Schema", + "description": "Schema that must not be valid for the instance to be valid.", + "markdownDescription": "Schema that must not be valid for the instance to be valid.", + "examples": [ + { + "type": "null" + }, + { + "type": "string", + "maxLength": 0 + } + ] + } + }, + "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not) for schema composition and logical operations. These keywords are mutually exclusive with `$ref` but can appear with any validation keywords.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not) for schema\ncomposition and logical operations. These keywords are mutually exclusive with\n`$ref` but can appear with any validation keywords.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" + }, + "Example": { + "type": "object", + "properties": { + "summary": { + "type": "string", + "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", + "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", + "examples": ["A user example", "An error response"] + }, + "description": { + "type": "string", + "description": "Long description for the example. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - description } |", + "markdownDescription": "Long description for the example. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - description } |", + "examples": [ + "A complete user object with all fields populated", + "An error response when the user is not found" + ] + }, + "value": { + "description": "Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - value } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - value } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - value } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - value } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - value } |", + "markdownDescription": "Embedded literal example. The value field and externalValue field are mutually exclusive.\nTo represent examples of media types that cannot naturally represented in JSON or YAML,\nuse a string value to contain the example, escaping where necessary.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - value } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - value } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - value } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - value } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - value } |", + "examples": [ + { + "name": "John Doe", + "email": "john@example.com" + }, + "example string value" + ] + }, + "externalValue": { + "type": "string", + "description": "A 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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - externalValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - externalValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - externalValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - externalValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - externalValue } |", + "markdownDescription": "A URL that points to the literal example. This provides the capability to reference\nexamples that cannot easily be included in JSON or YAML documents. The value field\nand externalValue field are mutually exclusive.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - externalValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - externalValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - externalValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - externalValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - externalValue } |", + "examples": [ + "https://example.com/examples/user-example.json", + "https://example.com/examples/error-example.xml" + ] + } + }, + "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example } |\n\n-----\nFields\n-----" + }, + "Reference": { + "type": "object", + "properties": { + "$ref": { + "type": "string", + "description": "The reference string. MUST be a valid JSON Reference.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference Object - $ref } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference Object - $ref } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference Object - $ref } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference Object - $ref } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference Object - $ref } |", + "markdownDescription": "The reference string. MUST be a valid JSON Reference.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference Object - $ref } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference Object - $ref } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference Object - $ref } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference Object - $ref } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference Object - $ref } |", + "examples": [ + "#/components/schemas/User", + "#/components/responses/NotFound", + "#/components/parameters/LimitParam" + ] + } + }, + "required": ["$ref"], + "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" + }, + "MediaType": { + "type": "object", + "properties": { + "schema": { + "anyOf": [ + { + "$ref": "#/definitions/Schema" + }, + { + "$ref": "#/definitions/Reference" + } + ], + "description": "The schema defining the type used for the request body.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object OpenAPI 3.0.4 Media Type Object - schema } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object OpenAPI 3.0.3 Media Type Object - schema } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object OpenAPI 3.0.2 Media Type Object - schema } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object OpenAPI 3.0.1 Media Type Object - schema } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type Object - schema } |", + "markdownDescription": "The schema defining the type used for the request body.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object OpenAPI 3.0.4 Media Type Object - schema } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object OpenAPI 3.0.3 Media Type Object - schema } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object OpenAPI 3.0.2 Media Type Object - schema } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object OpenAPI 3.0.1 Media Type Object - schema } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type Object - schema } |", + "examples": [ + { + "$ref": "#/components/schemas/User" + }, + { + "type": "object", + "properties": { + "name": { + "type": "string" + } + } + } + ] + }, + "example": { + "description": "Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example object is mutually exclusive of the examples object.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object OpenAPI 3.0.4 Media Type Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object OpenAPI 3.0.3 Media Type Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object OpenAPI 3.0.2 Media Type Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object OpenAPI 3.0.1 Media Type Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type Object - example } |", + "markdownDescription": "Example of the media type. The example object SHOULD be in the correct format\nas specified by the media type. The example object is mutually exclusive of\nthe examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object OpenAPI 3.0.4 Media Type Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object OpenAPI 3.0.3 Media Type Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object OpenAPI 3.0.2 Media Type Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object OpenAPI 3.0.1 Media Type Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type Object - example } |", + "examples": [ + { + "name": "John Doe", + "email": "john@example.com" + } + ] + }, + "examples": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Example" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The examples object is mutually exclusive of the example object.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object OpenAPI 3.0.4 Media Type Object - examples } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object OpenAPI 3.0.3 Media Type Object - examples } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object OpenAPI 3.0.2 Media Type Object - examples } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object OpenAPI 3.0.1 Media Type Object - examples } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type Object - examples } |", + "markdownDescription": "Examples of the media type. Each example object SHOULD match the media type\nand specified schema if present. The examples object is mutually exclusive of\nthe example object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object OpenAPI 3.0.4 Media Type Object - examples } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object OpenAPI 3.0.3 Media Type Object - examples } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object OpenAPI 3.0.2 Media Type Object - examples } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object OpenAPI 3.0.1 Media Type Object - examples } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type Object - examples } |", + "examples": [ + { + "user1": { + "summary": "A user example", + "value": { + "name": "John" + } + } + } + ] + }, + "encoding": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Encoding" + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object OpenAPI 3.0.4 Media Type Object - encoding } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object OpenAPI 3.0.3 Media Type Object - encoding } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object OpenAPI 3.0.2 Media Type Object - encoding } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object OpenAPI 3.0.1 Media Type Object - encoding } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type Object - encoding } |", + "markdownDescription": "A map between a property name and its encoding information. The key, being the\nproperty name, MUST exist in the schema as a property. The encoding object SHALL\nonly apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#media-type-object OpenAPI 3.0.4 Media Type Object - encoding } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#media-type-object OpenAPI 3.0.3 Media Type Object - encoding } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#media-type-object OpenAPI 3.0.2 Media Type Object - encoding } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#media-type-object OpenAPI 3.0.1 Media Type Object - encoding } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type Object - encoding } |", + "examples": [ + { + "profileImage": { + "contentType": "image/png" + } + } + ] + } + }, + "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#media-type-object OpenAPI 3.0.0 Media Type } |\n\n-----\nFields\n-----" + }, + "Encoding": { + "type": "object", + "properties": { + "contentType": { + "type": "string", + "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", + "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", + "examples": ["image/png", "application/json", "text/plain"] + }, + "headers": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Header" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "A map allowing additional information to be provided as headers, for example Content-Disposition. Content-Type is described separately and SHALL be ignored in this section.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - headers } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - headers } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - headers } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - headers } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - headers } |", + "markdownDescription": "A map allowing additional information to be provided as headers, for example\nContent-Disposition. Content-Type is described separately and SHALL be ignored in this section.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - headers } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - headers } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - headers } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - headers } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - headers } |", + "examples": [ + { + "Content-Disposition": { + "schema": { + "type": "string" + } + } + } + ] + }, + "style": { + "type": "string", + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], + "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", + "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", + "examples": ["form", "simple"] + }, + "explode": { + "type": "boolean", + "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", + "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", + "examples": [true, false] + }, + "allowReserved": { + "type": "boolean", + "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", + "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", + "examples": [true, false] + } + }, + "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n-----\nFields\n-----" + }, + "Header": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", + "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", + "examples": ["Rate limit for the current period", "Content type of the response"] + }, + "required": { + "type": "boolean", + "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", + "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", + "examples": [true, false] + }, + "deprecated": { + "type": "boolean", + "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", + "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", + "examples": [true, false] + }, + "allowEmptyValue": { + "type": "boolean", + "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", + "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", + "examples": [true, false] + }, + "style": { + "type": "string", + "const": "simple", + "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", + "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", + "examples": ["simple"] + }, + "explode": { + "type": "boolean", + "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", + "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", + "examples": [true, false] + }, + "schema": { + "anyOf": [ + { + "$ref": "#/definitions/Schema" + }, + { + "$ref": "#/definitions/Reference" + } + ], + "description": "The schema defining the type used for the header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - schema } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - schema } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - schema } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - schema } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - schema } |", + "markdownDescription": "The schema defining the type used for the header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - schema } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - schema } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - schema } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - schema } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - schema } |", + "examples": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "example": { + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", + "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", + "examples": ["example-value", 42] + }, + "examples": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Example" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the header encoding. The examples object is mutually exclusive of the example object.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - examples } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - examples } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - examples } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - examples } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - examples } |", + "markdownDescription": "Examples of the media type. Each example SHOULD contain a value in the correct format\nas specified in the header encoding. The examples object is mutually exclusive of\nthe example object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - examples } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - examples } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - examples } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - examples } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - examples } |", + "examples": [ + { + "header1": { + "summary": "A header example", + "value": "value123" + } + } + ] + }, + "content": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MediaType" + }, + "description": "A map containing the representations for the header. The key is the media type and the value describes it. The map MUST only contain one entry.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - content } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - content } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - content } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - content } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - content } |", + "markdownDescription": "A map containing the representations for the header. The key is the media type\nand the value describes it. The map MUST only contain one entry.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - content } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - content } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - content } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - content } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - content } |", + "examples": [ + { + "application/json": { + "schema": { + "type": "object" + } + } + } + ] + } + }, + "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. name MUST NOT be specified, it is given in the corresponding headers map. 2. in MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header } |\n\n----- Examples\n-----", + "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. name MUST NOT be specified, it is given in the corresponding headers map.\n2. in MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header } |\n\n-----\nExamples\n-----" + }, + "RequestBody": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", + "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", + "examples": ["User data to create", "Pet information"] + }, + "content": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MediaType" + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - content } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - content } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - content } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - content } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - content } |", + "markdownDescription": "The content of the request body. The key is a media type or media type range\nand the value describes it. For requests that match multiple keys, only the\nmost specific key is applicable.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - content } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - content } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - content } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - content } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - content } |", + "examples": [ + { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + ] + }, + "required": { + "type": "boolean", + "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", + "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", + "examples": [true], + "default": false + } + }, + "required": ["content"], + "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" + }, + "ResponsesMap": { + "type": "object", + "properties": { + "100": { + "$ref": "#/definitions/Response", + "description": "100 Continue\n\nIndicates that the initial part of the request has been received and the client should continue with the request.\n\nThe server has received the request headers and the client should proceed to send the request body.\n\nUsed in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns.\n\nThe server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone.", + "markdownDescription": "100 Continue\n\nIndicates that the initial part of the request has been received and the client should continue with the request.\n\nThe server has received the request headers and the client should proceed to send the request body.\n\nUsed in scenarios where the client needs to send a large request body and wants to confirm the server is ready to receive it before sending the data. Commonly used with `Expect: 100-continue` header for file uploads, API requests with large payloads, or when implementing optimistic request patterns.\n\nThe server is ready to process the request and the client can proceed with sending the request body. This prevents unnecessary data transmission if the server would reject the request based on headers alone." + }, + "101": { + "$ref": "#/definitions/Response", + "description": "101 Switching Protocols\n\nIndicates that the server is switching protocols as requested by the client.\n\nThe server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols.\n\nPrimarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios.\n\nThe connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol.", + "markdownDescription": "101 Switching Protocols\n\nIndicates that the server is switching protocols as requested by the client.\n\nThe server agrees to change the application protocol within the current connection, typically from HTTP to WebSocket or other protocols.\n\nPrimarily used for WebSocket connections where the client sends an `Upgrade: websocket` header and the server responds with 101 to establish the WebSocket connection. Also used for HTTP/2 upgrades, Server-Sent Events (SSE), or other protocol switching scenarios.\n\nThe connection will continue using a different protocol. The response headers will contain the new protocol information, and subsequent communication will use the upgraded protocol." + }, + "102": { + "$ref": "#/definitions/Response", + "description": "102 Processing\n\nIndicates that the server has received and is processing the request, but no response is available yet.\n\nThe server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting.\n\nPrimarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods.\n\nThe request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request.", + "markdownDescription": "102 Processing\n\nIndicates that the server has received and is processing the request, but no response is available yet.\n\nThe server has accepted the request and is processing it, but the processing is taking longer than normal and the client should continue waiting.\n\nPrimarily used in WebDAV (Web Distributed Authoring and Versioning) environments for long-running operations like file uploads, batch operations, or complex data processing. Helps prevent client timeouts during extended processing periods.\n\nThe request is being processed and the client should continue waiting. This prevents timeout issues during long-running operations and provides feedback that the server is actively working on the request." + }, + "103": { + "$ref": "#/definitions/Response", + "description": "103 Early Hints\n\nProvides early hints about the response that will be sent, allowing the client to start processing before the full response is ready.\n\nThe server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early.\n\nUsed for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance.\n\nThe client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience.", + "markdownDescription": "103 Early Hints\n\nProvides early hints about the response that will be sent, allowing the client to start processing before the full response is ready.\n\nThe server is sending preliminary information about the response headers and resources that will be needed, enabling the client to start optimization processes early.\n\nUsed for performance optimization, particularly in web applications where the server can hint about resources (CSS, JavaScript, fonts) that will be needed for the final response. Allows browsers to start preloading resources before the main response is ready, significantly improving perceived performance.\n\nThe client can start preparing for the response based on the hints provided. This is especially valuable for web applications where resource preloading can improve user experience." + }, + "104": { + "$ref": "#/definitions/Response", + "description": "104 Upload Resumption Supported — TEMPORARY\n\nIndicates that the server supports resumable uploads for the requested resource.\n\nThe server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off.\n\nUsed in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste.\n\nThe client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions.", + "markdownDescription": "104 Upload Resumption Supported — TEMPORARY\n\nIndicates that the server supports resumable uploads for the requested resource.\n\nThe server is indicating that it can handle interrupted uploads and allows the client to resume uploading from where it left off.\n\nUsed in file upload scenarios where large files might be interrupted due to network issues, browser crashes, or other problems. Enables clients to resume uploads without starting over, improving reliability for large file transfers and reducing bandwidth waste.\n\nThe client can implement resumable upload logic, typically using range requests or specialized upload protocols. This is particularly valuable for mobile applications and unreliable network conditions." + }, + "200": { + "$ref": "#/definitions/Response", + "description": "200 OK\n\nIndicates that the request has succeeded and the response contains the requested data.\n\nThe request was processed successfully and the response body contains the requested resource or data.\n\nThe most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return.\n\nThe operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations.", + "markdownDescription": "200 OK\n\nIndicates that the request has succeeded and the response contains the requested data.\n\nThe request was processed successfully and the response body contains the requested resource or data.\n\nThe most common success response for GET requests, API endpoints that return data, and successful operations. Used for retrieving resources, executing queries, and any operation that completes successfully with data to return.\n\nThe operation completed successfully and the response body contains the requested information. This is the standard success response for most API operations." + }, + "201": { + "$ref": "#/definitions/Response", + "description": "201 Created\n\nIndicates that the request has succeeded and a new resource has been created as a result.\n\nThe request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource.\n\nUsed for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations.\n\nA new resource was successfully created and the response contains information about the created resource, typically including its ID and location.", + "markdownDescription": "201 Created\n\nIndicates that the request has succeeded and a new resource has been created as a result.\n\nThe request was processed successfully and resulted in the creation of a new resource. The response typically includes the location of the newly created resource.\n\nUsed for POST requests that create new resources (users, posts, files, etc.). The response should include a `Location` header pointing to the newly created resource. Common in REST APIs for resource creation operations.\n\nA new resource was successfully created and the response contains information about the created resource, typically including its ID and location." + }, + "202": { + "$ref": "#/definitions/Response", + "description": "202 Accepted\n\nIndicates that the request has been accepted for processing, but the processing has not been completed.\n\nThe request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed.\n\nUsed for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone.\n\nThe request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result.", + "markdownDescription": "202 Accepted\n\nIndicates that the request has been accepted for processing, but the processing has not been completed.\n\nThe request was valid and accepted, but the server will process it asynchronously. The processing may or may not eventually succeed.\n\nUsed for asynchronous operations like background jobs, batch processing, email sending, or any operation that takes time to complete. The client should not assume the operation succeeded based on this response alone.\n\nThe request was accepted and is being processed asynchronously. The client should check the status separately or wait for a callback/webhook to know the final result." + }, + "203": { + "$ref": "#/definitions/Response", + "description": "203 Non-Authoritative Information\n\nIndicates that the request was successful, but the information returned is from a transformed or cached version of the original resource.\n\nThe response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version.\n\nUsed when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware.\n\nThe request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed.", + "markdownDescription": "203 Non-Authoritative Information\n\nIndicates that the request was successful, but the information returned is from a transformed or cached version of the original resource.\n\nThe response is successful but the data may have been modified by a transforming proxy or cache, and may not be the authoritative version.\n\nUsed when responses come from caches, proxies, or transformation services where the data might be slightly different from the original. Common in CDN scenarios or when data is processed through middleware.\n\nThe request succeeded but the response data may not be the most current or authoritative version. The client should be aware that the data might be cached or transformed." + }, + "204": { + "$ref": "#/definitions/Response", + "description": "204 No Content\n\nIndicates that the request has succeeded but there is no content to return in the response body.\n\nThe request was processed successfully but the response body is intentionally empty. The client should not expect any content.\n\nUsed for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data.\n\nThe operation completed successfully but no data is returned. The client should not attempt to parse a response body.", + "markdownDescription": "204 No Content\n\nIndicates that the request has succeeded but there is no content to return in the response body.\n\nThe request was processed successfully but the response body is intentionally empty. The client should not expect any content.\n\nUsed for DELETE operations, PUT requests that don't return data, or any operation where success is indicated by the absence of content. Common in REST APIs for operations that modify state without returning data.\n\nThe operation completed successfully but no data is returned. The client should not attempt to parse a response body." + }, + "205": { + "$ref": "#/definitions/Response", + "description": "205 Reset Content\n\nIndicates that the request has succeeded and the client should reset the document view that caused the request to be sent.\n\nThe request was processed successfully and the client should clear any form data or reset the user interface state.\n\nUsed in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations.\n\nThe operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface.", + "markdownDescription": "205 Reset Content\n\nIndicates that the request has succeeded and the client should reset the document view that caused the request to be sent.\n\nThe request was processed successfully and the client should clear any form data or reset the user interface state.\n\nUsed in web applications where form submissions should clear the form after successful processing, or when the client needs to reset its state. Common in form handling and user interface operations.\n\nThe operation succeeded and the client should reset its current state, typically clearing forms or resetting the user interface." + }, + "206": { + "$ref": "#/definitions/Response", + "description": "206 Partial Content\n\nIndicates that the server is delivering only part of the resource due to a range request.\n\nThe request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered.\n\nUsed for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads.\n\nThe response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource.", + "markdownDescription": "206 Partial Content\n\nIndicates that the server is delivering only part of the resource due to a range request.\n\nThe request included a Range header and the server is returning only the requested portion of the resource, along with information about the range delivered.\n\nUsed for resumable downloads, video streaming, large file transfers, and any scenario where the client requests a specific portion of a resource. Enables efficient handling of large files and interrupted downloads.\n\nThe response contains only a portion of the requested resource. The client should expect partial content and may need to make additional requests for the complete resource." + }, + "207": { + "$ref": "#/definitions/Response", + "description": "207 Multi-Status\n\nIndicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body.\n\nThe response contains multiple status codes for different operations, typically in XML format with individual operation results.\n\nUsed in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms.\n\nMultiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed.", + "markdownDescription": "207 Multi-Status\n\nIndicates that multiple independent operations might have been performed, and the status of each operation is reported in the response body.\n\nThe response contains multiple status codes for different operations, typically in XML format with individual operation results.\n\nUsed in WebDAV environments for batch operations, bulk file operations, or any scenario where multiple independent operations are performed in a single request. Common in file management systems and collaborative editing platforms.\n\nMultiple operations were attempted and the response contains the status of each individual operation. The client should parse the response body to determine which operations succeeded or failed." + }, + "208": { + "$ref": "#/definitions/Response", + "description": "208 Already Reported\n\nIndicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again.\n\nUsed in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported.\n\nUsed in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations.\n\nThe information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding.", + "markdownDescription": "208 Already Reported\n\nIndicates that the members of a DAV binding have already been enumerated in a previous response to this request, and are not being included again.\n\nUsed in WebDAV to avoid repeating the same information in a multi-status response when the same binding has already been reported.\n\nUsed in WebDAV environments to optimize responses by avoiding duplicate information in multi-status responses. Helps reduce response size and improve performance in complex file system operations.\n\nThe information for this binding has already been reported in a previous part of the response. The client should not expect additional information for this specific binding." + }, + "226": { + "$ref": "#/definitions/Response", + "description": "226 IM Used\n\nIndicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.\n\nThe response represents the result of applying instance manipulations (like delta encoding) to the current resource instance.\n\nUsed in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission.\n\nThe response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed.", + "markdownDescription": "226 IM Used\n\nIndicates that the server has fulfilled a request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance.\n\nThe response represents the result of applying instance manipulations (like delta encoding) to the current resource instance.\n\nUsed in scenarios involving delta encoding, instance manipulations, or when the response represents a transformed version of the resource. Common in content delivery networks and systems that optimize data transmission.\n\nThe response contains a manipulated version of the resource, typically optimized for transmission. The client should be aware that the data has been processed or transformed." + }, + "300": { + "$ref": "#/definitions/Response", + "description": "300 Multiple Choices\n\nIndicates that the request has multiple possible responses and the client should choose one.\n\nThe server has multiple representations of the requested resource and the client must choose which one to use.\n\nUsed when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics.\n\nThe client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers.", + "markdownDescription": "300 Multiple Choices\n\nIndicates that the request has multiple possible responses and the client should choose one.\n\nThe server has multiple representations of the requested resource and the client must choose which one to use.\n\nUsed when content negotiation results in multiple valid options, such as different formats (JSON, XML, HTML) or different languages. The response typically includes a list of available options with their characteristics.\n\nThe client should examine the available options and make a choice, typically by sending another request with more specific preferences or headers." + }, + "301": { + "$ref": "#/definitions/Response", + "description": "301 Moved Permanently\n\nIndicates that the requested resource has been permanently moved to a new location.\n\nThe resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header.\n\nUsed when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches.\n\nThe resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes.", + "markdownDescription": "301 Moved Permanently\n\nIndicates that the requested resource has been permanently moved to a new location.\n\nThe resource has been permanently relocated and all future requests should be directed to the new URL provided in the Location header.\n\nUsed when resources are permanently relocated, such as when changing domain names, restructuring URLs, or moving content to new locations. Browsers and clients should update their bookmarks and caches.\n\nThe resource has moved permanently and the client should update all references to use the new URL. Search engines and caches should update their indexes." + }, + "302": { + "$ref": "#/definitions/Response", + "description": "302 Found\n\nIndicates that the requested resource has been temporarily moved to a different location.\n\nThe resource is temporarily available at a different URL, but the original URL should continue to be used for future requests.\n\nUsed for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid.\n\nThe resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests.", + "markdownDescription": "302 Found\n\nIndicates that the requested resource has been temporarily moved to a different location.\n\nThe resource is temporarily available at a different URL, but the original URL should continue to be used for future requests.\n\nUsed for temporary redirects such as maintenance pages, temporary content moves, or when the resource is temporarily unavailable at the original location. The original URL remains valid.\n\nThe resource is temporarily at a different location. The client should follow the redirect but continue using the original URL for future requests." + }, + "303": { + "$ref": "#/definitions/Response", + "description": "303 See Other\n\nIndicates that the response to the request can be found at a different URL and should be retrieved using a GET request.\n\nThe request was processed but the response is available at a different location, and the client should use GET to retrieve it.\n\nUsed in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions.\n\nThe client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result.", + "markdownDescription": "303 See Other\n\nIndicates that the response to the request can be found at a different URL and should be retrieved using a GET request.\n\nThe request was processed but the response is available at a different location, and the client should use GET to retrieve it.\n\nUsed in POST-redirect-GET patterns, form submissions that redirect to a results page, or when the response to a POST request should be retrieved via GET. Common in web applications for avoiding duplicate form submissions.\n\nThe client should make a GET request to the provided URL to retrieve the response. This prevents duplicate submissions and provides a clean URL for the result." + }, + "304": { + "$ref": "#/definitions/Response", + "description": "304 Not Modified\n\nIndicates that the resource has not been modified since the last request, so the cached version can be used.\n\nThe resource has not changed since the last request, and the client can use its cached version. No response body is included.\n\nUsed for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer.\n\nThe resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance.", + "markdownDescription": "304 Not Modified\n\nIndicates that the resource has not been modified since the last request, so the cached version can be used.\n\nThe resource has not changed since the last request, and the client can use its cached version. No response body is included.\n\nUsed for caching optimization when the client sends conditional headers (If-Modified-Since, If-None-Match). Reduces bandwidth usage and improves performance by avoiding unnecessary data transfer.\n\nThe resource has not changed and the client should use its cached version. This is an optimization response that saves bandwidth and improves performance." + }, + "305": { + "$ref": "#/definitions/Response", + "description": "305 Use Proxy\n\nIndicates that the requested resource must be accessed through the proxy specified in the Location header.\n\nThe client must use the specified proxy to access the resource. This response is rarely used in modern web applications.\n\nUsed in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development.\n\nThe client should use the specified proxy to access the resource. This is rarely encountered in modern web applications.", + "markdownDescription": "305 Use Proxy\n\nIndicates that the requested resource must be accessed through the proxy specified in the Location header.\n\nThe client must use the specified proxy to access the resource. This response is rarely used in modern web applications.\n\nUsed in corporate environments or specific network configurations where resources must be accessed through a particular proxy server. Mostly deprecated in modern web development.\n\nThe client should use the specified proxy to access the resource. This is rarely encountered in modern web applications." + }, + "306": { + "$ref": "#/definitions/Response", + "description": "306 (Unused)\n\nThis status code is reserved and not used in current HTTP specifications.\n\nThis status code was previously used but is now reserved and should not be used in new implementations.\n\nNot used in modern web applications. This code is reserved and should not be implemented.\n\nThis status code should not be encountered in modern web applications.", + "markdownDescription": "306 (Unused)\n\nThis status code is reserved and not used in current HTTP specifications.\n\nThis status code was previously used but is now reserved and should not be used in new implementations.\n\nNot used in modern web applications. This code is reserved and should not be implemented.\n\nThis status code should not be encountered in modern web applications." + }, + "307": { + "$ref": "#/definitions/Response", + "description": "307 Temporary Redirect\n\nIndicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved.\n\nThe resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location.\n\nUsed for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated.\n\nThe resource is temporarily at a different location and the client should repeat the same request method to the new URL.", + "markdownDescription": "307 Temporary Redirect\n\nIndicates that the requested resource has been temporarily moved to a different location, and the request method should be preserved.\n\nThe resource is temporarily available at a different URL, and the client should repeat the request using the same method to the new location.\n\nUsed for temporary redirects where the HTTP method (POST, PUT, DELETE) should be preserved. Common in API versioning, temporary maintenance, or when resources are temporarily relocated.\n\nThe resource is temporarily at a different location and the client should repeat the same request method to the new URL." + }, + "308": { + "$ref": "#/definitions/Response", + "description": "308 Permanent Redirect\n\nIndicates that the requested resource has been permanently moved to a different location, and the request method should be preserved.\n\nThe resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method.\n\nUsed for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations.\n\nThe resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method.", + "markdownDescription": "308 Permanent Redirect\n\nIndicates that the requested resource has been permanently moved to a different location, and the request method should be preserved.\n\nThe resource has been permanently relocated and the client should use the new URL for all future requests, preserving the original HTTP method.\n\nUsed for permanent redirects where the HTTP method should be preserved, such as when moving APIs to new endpoints or restructuring resource URLs. Common in API versioning and permanent relocations.\n\nThe resource has moved permanently and the client should update all references to use the new URL while preserving the original HTTP method." + }, + "400": { + "$ref": "#/definitions/Response", + "description": "400 Bad Request\n\nIndicates that the server cannot process the request due to a client error.\n\nThe request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process.\n\nUsed for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios.\n\nThe client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request.", + "markdownDescription": "400 Bad Request\n\nIndicates that the server cannot process the request due to a client error.\n\nThe request syntax is invalid, malformed, or contains incorrect parameters that the server cannot understand or process.\n\nUsed for validation errors, malformed JSON, missing required fields, invalid parameter values, or any client-side error that prevents the server from processing the request. Common in API validation scenarios.\n\nThe client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request." + }, + "401": { + "$ref": "#/definitions/Response", + "description": "401 Unauthorized\n\nIndicates that the request requires authentication and the client has not provided valid credentials.\n\nThe request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient.\n\nUsed when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows.\n\nThe client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate.", + "markdownDescription": "401 Unauthorized\n\nIndicates that the request requires authentication and the client has not provided valid credentials.\n\nThe request lacks valid authentication credentials or the provided credentials are invalid, expired, or insufficient.\n\nUsed when authentication is required but not provided, when login credentials are invalid, or when the authentication token has expired. Common in protected API endpoints and user authentication flows.\n\nThe client needs to authenticate before accessing the resource. The response should include authentication challenge headers (WWW-Authenticate) indicating how to authenticate." + }, + "402": { + "$ref": "#/definitions/Response", + "description": "402 Payment Required\n\nIndicates that the request requires payment before it can be processed.\n\nThe request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems.\n\nUsed in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services.\n\nThe client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment.", + "markdownDescription": "402 Payment Required\n\nIndicates that the request requires payment before it can be processed.\n\nThe request cannot be fulfilled because payment is required. This status code is reserved for future use in digital payment systems.\n\nUsed in payment-required scenarios, subscription services, or when access to a resource requires payment. Common in freemium models, paid API access, or premium content services.\n\nThe client needs to provide payment information or complete a payment process before accessing the resource. The response should include information about how to make the payment." + }, + "403": { + "$ref": "#/definitions/Response", + "description": "403 Forbidden\n\nIndicates that the server understood the request but refuses to authorize it.\n\nThe client is authenticated but does not have permission to access the requested resource or perform the requested action.\n\nUsed when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios.\n\nThe client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions.", + "markdownDescription": "403 Forbidden\n\nIndicates that the server understood the request but refuses to authorize it.\n\nThe client is authenticated but does not have permission to access the requested resource or perform the requested action.\n\nUsed when the user is logged in but lacks the necessary permissions, when access is restricted based on user roles, or when the resource is not accessible to the current user. Common in authorization and access control scenarios.\n\nThe client is authenticated but not authorized to access the resource. The client should not retry the request without additional permissions." + }, + "404": { + "$ref": "#/definitions/Response", + "description": "404 Not Found\n\nIndicates that the requested resource could not be found on the server.\n\nThe server cannot find the requested resource at the specified URL, or the resource does not exist.\n\nUsed when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints.\n\nThe requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted.", + "markdownDescription": "404 Not Found\n\nIndicates that the requested resource could not be found on the server.\n\nThe server cannot find the requested resource at the specified URL, or the resource does not exist.\n\nUsed when a resource doesn't exist, when the URL is incorrect, or when the requested item has been deleted. Common in web applications for missing pages, deleted content, or non-existent API endpoints.\n\nThe requested resource does not exist. The client should verify the URL or check if the resource has been moved or deleted." + }, + "405": { + "$ref": "#/definitions/Response", + "description": "405 Method Not Allowed\n\nIndicates that the HTTP method used in the request is not allowed for the requested resource.\n\nThe resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource.\n\nUsed when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design.\n\nThe HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods.", + "markdownDescription": "405 Method Not Allowed\n\nIndicates that the HTTP method used in the request is not allowed for the requested resource.\n\nThe resource exists but the HTTP method (GET, POST, PUT, DELETE, etc.) is not supported for this particular resource.\n\nUsed when a resource only supports certain HTTP methods, such as a read-only endpoint that doesn't allow POST requests, or when the method is not implemented for the specific resource. Common in REST API design.\n\nThe HTTP method is not allowed for this resource. The response should include an Allow header listing the permitted methods." + }, + "406": { + "$ref": "#/definitions/Response", + "description": "406 Not Acceptable\n\nIndicates that the server cannot produce a response matching the client's Accept headers.\n\nThe server cannot generate a response in any of the formats requested by the client's Accept headers.\n\nUsed when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches.\n\nThe server cannot provide the requested content type. The client should check the Accept headers or request a different format.", + "markdownDescription": "406 Not Acceptable\n\nIndicates that the server cannot produce a response matching the client's Accept headers.\n\nThe server cannot generate a response in any of the formats requested by the client's Accept headers.\n\nUsed when the client requests a specific content type (JSON, XML, HTML) that the server cannot provide, or when content negotiation fails. Common in API versioning and content type mismatches.\n\nThe server cannot provide the requested content type. The client should check the Accept headers or request a different format." + }, + "407": { + "$ref": "#/definitions/Response", + "description": "407 Proxy Authentication Required\n\nIndicates that the client must authenticate with the proxy server before the request can be processed.\n\nThe proxy server requires authentication before it will forward the request to the destination server.\n\nUsed in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies.\n\nThe client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate.", + "markdownDescription": "407 Proxy Authentication Required\n\nIndicates that the client must authenticate with the proxy server before the request can be processed.\n\nThe proxy server requires authentication before it will forward the request to the destination server.\n\nUsed in corporate environments or networks where proxy authentication is required. Common in enterprise networks, VPN connections, or when accessing resources through authenticated proxies.\n\nThe client needs to authenticate with the proxy server. The response should include Proxy-Authenticate headers indicating how to authenticate." + }, + "408": { + "$ref": "#/definitions/Response", + "description": "408 Request Timeout\n\nIndicates that the server timed out while waiting for the request from the client.\n\nThe server did not receive a complete request within the time it was prepared to wait.\n\nUsed when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests.\n\nThe request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity.", + "markdownDescription": "408 Request Timeout\n\nIndicates that the server timed out while waiting for the request from the client.\n\nThe server did not receive a complete request within the time it was prepared to wait.\n\nUsed when the client takes too long to send the complete request, when network issues cause delays, or when the server has a timeout policy for request processing. Common in slow network conditions or when clients fail to send complete requests.\n\nThe request timed out and the client should retry the request. The client may need to optimize the request or check network connectivity." + }, + "409": { + "$ref": "#/definitions/Response", + "description": "409 Conflict\n\nIndicates that the request conflicts with the current state of the resource.\n\nThe request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification.\n\nUsed when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios.\n\nThe request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request.", + "markdownDescription": "409 Conflict\n\nIndicates that the request conflicts with the current state of the resource.\n\nThe request cannot be completed due to a conflict with the current state of the resource, such as a version mismatch or concurrent modification.\n\nUsed when trying to create a resource that already exists, when there's a version conflict in concurrent editing, or when the request conflicts with business rules. Common in collaborative editing, version control, and resource creation scenarios.\n\nThe request conflicts with the current state of the resource. The client should resolve the conflict before retrying the request." + }, + "410": { + "$ref": "#/definitions/Response", + "description": "410 Gone\n\nIndicates that the requested resource is no longer available and will not be available again.\n\nThe resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found.\n\nUsed when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios.\n\nThe resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource.", + "markdownDescription": "410 Gone\n\nIndicates that the requested resource is no longer available and will not be available again.\n\nThe resource has been permanently removed and will not be restored. This is different from 404, which indicates the resource was never found.\n\nUsed when content has been permanently deleted, when resources have been removed and will not be restored, or when temporary content has expired. Common in content management systems and temporary resource scenarios.\n\nThe resource has been permanently removed and will not be available again. The client should not retry the request and should update any references to this resource." + }, + "411": { + "$ref": "#/definitions/Response", + "description": "411 Length Required\n\nIndicates that the server requires a Content-Length header in the request.\n\nThe server cannot process the request without knowing the exact length of the request body.\n\nUsed when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints.\n\nThe client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header.", + "markdownDescription": "411 Length Required\n\nIndicates that the server requires a Content-Length header in the request.\n\nThe server cannot process the request without knowing the exact length of the request body.\n\nUsed when the server needs to know the exact size of the request body before processing, such as for file uploads, large data transfers, or when implementing specific security measures. Common in file upload scenarios and certain API endpoints.\n\nThe client must include a Content-Length header in the request. The client should retry the request with the proper Content-Length header." + }, + "412": { + "$ref": "#/definitions/Response", + "description": "412 Precondition Failed\n\nIndicates that one or more preconditions in the request headers were not met.\n\nThe server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since.\n\nUsed in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios.\n\nThe preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions.", + "markdownDescription": "412 Precondition Failed\n\nIndicates that one or more preconditions in the request headers were not met.\n\nThe server cannot meet the conditions specified in the request headers, such as If-Match, If-None-Match, If-Modified-Since, or If-Unmodified-Since.\n\nUsed in conditional requests where the client specifies conditions that must be met, such as version checking, cache validation, or optimistic concurrency control. Common in collaborative editing and caching scenarios.\n\nThe preconditions in the request were not met. The client should check the conditions and retry the request with updated preconditions." + }, + "413": { + "$ref": "#/definitions/Response", + "description": "413 Content Too Large\n\nIndicates that the request payload is too large for the server to process.\n\nThe request body exceeds the server's maximum allowed size limit.\n\nUsed when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting.\n\nThe request payload is too large. The client should reduce the size of the request body or split it into smaller chunks.", + "markdownDescription": "413 Content Too Large\n\nIndicates that the request payload is too large for the server to process.\n\nThe request body exceeds the server's maximum allowed size limit.\n\nUsed when file uploads exceed size limits, when request bodies are too large for processing, or when the server has configured size restrictions. Common in file upload scenarios and API rate limiting.\n\nThe request payload is too large. The client should reduce the size of the request body or split it into smaller chunks." + }, + "414": { + "$ref": "#/definitions/Response", + "description": "414 URI Too Long\n\nIndicates that the URI provided in the request is too long for the server to process.\n\nThe URL exceeds the server's maximum allowed length limit.\n\nUsed when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests.\n\nThe URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data.", + "markdownDescription": "414 URI Too Long\n\nIndicates that the URI provided in the request is too long for the server to process.\n\nThe URL exceeds the server's maximum allowed length limit.\n\nUsed when URLs are too long due to excessive query parameters, when GET requests contain too much data in the URL, or when the server has configured URI length restrictions. Common in search APIs and parameter-heavy requests.\n\nThe URI is too long. The client should shorten the URL or use POST instead of GET for large amounts of data." + }, + "415": { + "$ref": "#/definitions/Response", + "description": "415 Unsupported Media Type\n\nIndicates that the server cannot process the request because the media type is not supported.\n\nThe server cannot process the request body because the Content-Type is not supported or recognized.\n\nUsed when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements.\n\nThe content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header.", + "markdownDescription": "415 Unsupported Media Type\n\nIndicates that the server cannot process the request because the media type is not supported.\n\nThe server cannot process the request body because the Content-Type is not supported or recognized.\n\nUsed when the client sends data in an unsupported format, when the server only accepts specific content types, or when there's a mismatch between the expected and actual content type. Common in API endpoints with strict content type requirements.\n\nThe content type is not supported. The client should check the API documentation for supported content types and retry with the correct Content-Type header." + }, + "416": { + "$ref": "#/definitions/Response", + "description": "416 Range Not Satisfiable\n\nIndicates that the server cannot satisfy the range request specified in the Range header.\n\nThe requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests.\n\nUsed when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming.\n\nThe range request is not satisfiable. The client should check the range specification or request the full resource.", + "markdownDescription": "416 Range Not Satisfiable\n\nIndicates that the server cannot satisfy the range request specified in the Range header.\n\nThe requested range is not valid for the resource, either because the range is beyond the resource size or the resource doesn't support range requests.\n\nUsed when range requests are invalid, when the requested range exceeds the resource size, or when the resource doesn't support partial content requests. Common in file download scenarios and media streaming.\n\nThe range request is not satisfiable. The client should check the range specification or request the full resource." + }, + "417": { + "$ref": "#/definitions/Response", + "description": "417 Expectation Failed\n\nIndicates that the server cannot meet the requirements of the Expect header.\n\nThe server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation.\n\nUsed when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations.\n\nThe server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request.", + "markdownDescription": "417 Expectation Failed\n\nIndicates that the server cannot meet the requirements of the Expect header.\n\nThe server cannot fulfill the expectations specified in the Expect header, typically when the server cannot handle the 100-continue expectation.\n\nUsed when the server cannot handle the Expect: 100-continue header, when the server doesn't support the expected behavior, or when there's a mismatch between client expectations and server capabilities. Common in HTTP/1.1 implementations.\n\nThe server cannot meet the expectations in the request. The client should retry without the Expect header or adjust the request." + }, + "418": { + "$ref": "#/definitions/Response", + "description": "418 (Unused)\n\nThis status code is reserved and not used in current HTTP specifications.\n\nThis status code is reserved and should not be used in new implementations.\n\nNot used in modern web applications. This code is reserved and should not be implemented.\n\nThis status code should not be encountered in modern web applications.", + "markdownDescription": "418 (Unused)\n\nThis status code is reserved and not used in current HTTP specifications.\n\nThis status code is reserved and should not be used in new implementations.\n\nNot used in modern web applications. This code is reserved and should not be implemented.\n\nThis status code should not be encountered in modern web applications." + }, + "421": { + "$ref": "#/definitions/Response", + "description": "421 Misdirected Request\n\nIndicates that the request was directed to a server that is not able to produce a response.\n\nThe request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems.\n\nUsed in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios.\n\nThe request was sent to the wrong server. The client should retry the request, which may be routed to a different server.", + "markdownDescription": "421 Misdirected Request\n\nIndicates that the request was directed to a server that is not able to produce a response.\n\nThe request was sent to a server that cannot handle it, typically due to HTTP/2 connection reuse issues or server configuration problems.\n\nUsed in HTTP/2 environments when a request is sent to the wrong server due to connection reuse, when there are server configuration issues, or when the request cannot be processed by the current server instance. Common in load balancing scenarios.\n\nThe request was sent to the wrong server. The client should retry the request, which may be routed to a different server." + }, + "422": { + "$ref": "#/definitions/Response", + "description": "422 Unprocessable Content\n\nIndicates that the request is well-formed but contains semantic errors that prevent processing.\n\nThe request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations.\n\nUsed for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid.\n\nThe request is well-formed but contains semantic errors. The client should fix the data and retry the request.", + "markdownDescription": "422 Unprocessable Content\n\nIndicates that the request is well-formed but contains semantic errors that prevent processing.\n\nThe request syntax is correct but the server cannot process the request due to semantic errors, such as validation failures or business rule violations.\n\nUsed for validation errors, business rule violations, or when the request is syntactically correct but logically invalid. Common in API validation scenarios where the request format is correct but the data is invalid.\n\nThe request is well-formed but contains semantic errors. The client should fix the data and retry the request." + }, + "423": { + "$ref": "#/definitions/Response", + "description": "423 Locked\n\nIndicates that the requested resource is locked and cannot be modified.\n\nThe resource is locked by another process or user and cannot be accessed or modified at this time.\n\nUsed in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms.\n\nThe resource is locked and cannot be accessed. The client should wait and retry the request later.", + "markdownDescription": "423 Locked\n\nIndicates that the requested resource is locked and cannot be modified.\n\nThe resource is locked by another process or user and cannot be accessed or modified at this time.\n\nUsed in WebDAV environments for file locking, collaborative editing scenarios, or when resources are temporarily locked for maintenance. Common in document management systems and collaborative editing platforms.\n\nThe resource is locked and cannot be accessed. The client should wait and retry the request later." + }, + "424": { + "$ref": "#/definitions/Response", + "description": "424 Failed Dependency\n\nIndicates that the request failed because it depended on another request that also failed.\n\nThe request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations.\n\nUsed in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios.\n\nThe request failed due to a dependency failure. The client should check the dependencies and retry the request.", + "markdownDescription": "424 Failed Dependency\n\nIndicates that the request failed because it depended on another request that also failed.\n\nThe request cannot be completed because it depends on another operation that failed, typically in batch or multi-part operations.\n\nUsed in WebDAV environments for batch operations where one operation depends on another, or in complex workflows where operations have dependencies. Common in file management systems and collaborative editing scenarios.\n\nThe request failed due to a dependency failure. The client should check the dependencies and retry the request." + }, + "425": { + "$ref": "#/definitions/Response", + "description": "425 Too Early\n\nIndicates that the server is unwilling to process the request because it might be replayed.\n\nThe server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns.\n\nUsed in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols.\n\nThe server is unwilling to process the request due to replay concerns. The client should retry the request later.", + "markdownDescription": "425 Too Early\n\nIndicates that the server is unwilling to process the request because it might be replayed.\n\nThe server is concerned that the request might be replayed and is unwilling to process it at this time, typically due to timing or security concerns.\n\nUsed in scenarios where request replay is a security concern, such as in early data scenarios or when the server needs to prevent replay attacks. Common in security-sensitive applications and protocols.\n\nThe server is unwilling to process the request due to replay concerns. The client should retry the request later." + }, + "426": { + "$ref": "#/definitions/Response", + "description": "426 Upgrade Required\n\nIndicates that the server requires the client to upgrade to a different protocol.\n\nThe server requires the client to use a different protocol version or upgrade to a newer version to access the resource.\n\nUsed when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios.\n\nThe client must upgrade to a different protocol version. The response should include upgrade information.", + "markdownDescription": "426 Upgrade Required\n\nIndicates that the server requires the client to upgrade to a different protocol.\n\nThe server requires the client to use a different protocol version or upgrade to a newer version to access the resource.\n\nUsed when the server requires protocol upgrades, when the client is using an outdated protocol version, or when the server only supports newer protocol versions. Common in API versioning and protocol migration scenarios.\n\nThe client must upgrade to a different protocol version. The response should include upgrade information." + }, + "428": { + "$ref": "#/definitions/Response", + "description": "428 Precondition Required\n\nIndicates that the server requires the request to include certain preconditions.\n\nThe server requires the client to include specific preconditions in the request headers before it will process the request.\n\nUsed when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios.\n\nThe server requires specific preconditions. The client should include the required preconditions and retry the request.", + "markdownDescription": "428 Precondition Required\n\nIndicates that the server requires the request to include certain preconditions.\n\nThe server requires the client to include specific preconditions in the request headers before it will process the request.\n\nUsed when the server requires specific preconditions for security or consistency reasons, such as requiring If-Match headers for optimistic concurrency control or other conditional headers. Common in collaborative editing and version control scenarios.\n\nThe server requires specific preconditions. The client should include the required preconditions and retry the request." + }, + "429": { + "$ref": "#/definitions/Response", + "description": "429 Too Many Requests\n\nIndicates that the client has sent too many requests in a given time period and should slow down.\n\nThe client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets.\n\nUsed for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers.\n\nThe client has exceeded the rate limit and should slow down. The client should wait before retrying the request.", + "markdownDescription": "429 Too Many Requests\n\nIndicates that the client has sent too many requests in a given time period and should slow down.\n\nThe client has exceeded the rate limit and the server is refusing to process additional requests until the rate limit resets.\n\nUsed for rate limiting, API throttling, and preventing abuse. Common in API endpoints that need to control request frequency, prevent spam, or manage resource usage. Often includes retry-after headers.\n\nThe client has exceeded the rate limit and should slow down. The client should wait before retrying the request." + }, + "431": { + "$ref": "#/definitions/Response", + "description": "431 Request Header Fields Too Large\n\nIndicates that the server is unwilling to process the request because the header fields are too large.\n\nThe request headers exceed the server's maximum allowed size limit.\n\nUsed when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data.\n\nThe request headers are too large. The client should reduce the size of the headers and retry the request.", + "markdownDescription": "431 Request Header Fields Too Large\n\nIndicates that the server is unwilling to process the request because the header fields are too large.\n\nThe request headers exceed the server's maximum allowed size limit.\n\nUsed when request headers are too large, when there are too many headers, or when individual headers exceed size limits. Common in scenarios with large authentication tokens or excessive header data.\n\nThe request headers are too large. The client should reduce the size of the headers and retry the request." + }, + "451": { + "$ref": "#/definitions/Response", + "description": "451 Unavailable For Legal Reasons\n\nIndicates that the requested resource is unavailable due to legal reasons.\n\nThe resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements.\n\nUsed when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services.\n\nThe resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available.", + "markdownDescription": "451 Unavailable For Legal Reasons\n\nIndicates that the requested resource is unavailable due to legal reasons.\n\nThe resource is not available due to legal restrictions, such as censorship, court orders, or regulatory requirements.\n\nUsed when content is blocked due to legal restrictions, when resources are unavailable in certain jurisdictions, or when there are regulatory compliance issues. Common in content delivery networks and international services.\n\nThe resource is unavailable due to legal restrictions. The client should not retry the request as it will not be available." + }, + "500": { + "$ref": "#/definitions/Response", + "description": "500 Internal Server Error\n\nIndicates that the server encountered an unexpected condition that prevented it from fulfilling the request.\n\nThe server encountered an internal error or exception that prevented it from processing the request successfully.\n\nUsed for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems.\n\nThe server encountered an internal error. The client should retry the request later, as this is typically a temporary issue.", + "markdownDescription": "500 Internal Server Error\n\nIndicates that the server encountered an unexpected condition that prevented it from fulfilling the request.\n\nThe server encountered an internal error or exception that prevented it from processing the request successfully.\n\nUsed for server-side errors, unhandled exceptions, database connection failures, or any unexpected server-side issue. Common in applications when there are bugs, configuration issues, or resource problems.\n\nThe server encountered an internal error. The client should retry the request later, as this is typically a temporary issue." + }, + "501": { + "$ref": "#/definitions/Response", + "description": "501 Not Implemented\n\nIndicates that the server does not support the functionality required to fulfill the request.\n\nThe server does not recognize the request method or lacks the ability to fulfill the request.\n\nUsed when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented.\n\nThe server does not support the requested functionality. The client should check the API documentation for supported methods and features.", + "markdownDescription": "501 Not Implemented\n\nIndicates that the server does not support the functionality required to fulfill the request.\n\nThe server does not recognize the request method or lacks the ability to fulfill the request.\n\nUsed when the server doesn't support the requested HTTP method, when functionality is not implemented, or when the server cannot handle the request. Common in API development when endpoints are not yet implemented.\n\nThe server does not support the requested functionality. The client should check the API documentation for supported methods and features." + }, + "502": { + "$ref": "#/definitions/Response", + "description": "502 Bad Gateway\n\nIndicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server.\n\nThe server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access.\n\nUsed in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems.\n\nThe gateway received an invalid response from the upstream server. The client should retry the request later.", + "markdownDescription": "502 Bad Gateway\n\nIndicates that the server, while acting as a gateway or proxy, received an invalid response from an upstream server.\n\nThe server acting as a gateway or proxy received an invalid response from the upstream server it was trying to access.\n\nUsed in load balancers, reverse proxies, and API gateways when the upstream server returns an invalid response or is unreachable. Common in microservices architectures and distributed systems.\n\nThe gateway received an invalid response from the upstream server. The client should retry the request later." + }, + "503": { + "$ref": "#/definitions/Response", + "description": "503 Service Unavailable\n\nIndicates that the server is temporarily unable to handle the request due to maintenance or overload.\n\nThe server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints.\n\nUsed during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows.\n\nThe server is temporarily unavailable. The client should retry the request later, often with exponential backoff.", + "markdownDescription": "503 Service Unavailable\n\nIndicates that the server is temporarily unable to handle the request due to maintenance or overload.\n\nThe server is temporarily unavailable, typically due to maintenance, overload, or temporary resource constraints.\n\nUsed during server maintenance, when the server is overloaded, when there are temporary resource issues, or when the service is temporarily down. Common in high-traffic scenarios and planned maintenance windows.\n\nThe server is temporarily unavailable. The client should retry the request later, often with exponential backoff." + }, + "504": { + "$ref": "#/definitions/Response", + "description": "504 Gateway Timeout\n\nIndicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server.\n\nThe gateway or proxy server timed out while waiting for a response from the upstream server.\n\nUsed in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times.\n\nThe gateway timed out waiting for the upstream server. The client should retry the request later.", + "markdownDescription": "504 Gateway Timeout\n\nIndicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream server.\n\nThe gateway or proxy server timed out while waiting for a response from the upstream server.\n\nUsed in load balancers, reverse proxies, and API gateways when the upstream server takes too long to respond. Common in microservices architectures where services have different response times.\n\nThe gateway timed out waiting for the upstream server. The client should retry the request later." + }, + "505": { + "$ref": "#/definitions/Response", + "description": "505 HTTP Version Not Supported\n\nIndicates that the server does not support the HTTP protocol version used in the request.\n\nThe server does not support the HTTP protocol version specified in the request.\n\nUsed when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios.\n\nThe server does not support the HTTP version used in the request. The client should use a supported HTTP version.", + "markdownDescription": "505 HTTP Version Not Supported\n\nIndicates that the server does not support the HTTP protocol version used in the request.\n\nThe server does not support the HTTP protocol version specified in the request.\n\nUsed when the client uses an unsupported HTTP version, when the server only supports specific HTTP versions, or when there are protocol version mismatches. Common in legacy systems and protocol migration scenarios.\n\nThe server does not support the HTTP version used in the request. The client should use a supported HTTP version." + }, + "506": { + "$ref": "#/definitions/Response", + "description": "506 Variant Also Negotiates\n\nIndicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation.\n\nThe server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop.\n\nUsed in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations.\n\nThe server has a configuration error in content negotiation. The client should contact the server administrator.", + "markdownDescription": "506 Variant Also Negotiates\n\nIndicates that the server has an internal configuration error in which the chosen variant resource is configured to engage in transparent content negotiation.\n\nThe server has a configuration error where the selected variant resource is configured to engage in transparent content negotiation, creating a negotiation loop.\n\nUsed in content negotiation scenarios where there's a configuration error causing negotiation loops. Common in complex content delivery systems and advanced HTTP implementations.\n\nThe server has a configuration error in content negotiation. The client should contact the server administrator." + }, + "507": { + "$ref": "#/definitions/Response", + "description": "507 Insufficient Storage\n\nIndicates that the server is unable to store the representation needed to complete the request.\n\nThe server cannot store the representation required to complete the request, typically due to storage space limitations.\n\nUsed in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms.\n\nThe server cannot store the required representation. The client should check storage availability and retry the request.", + "markdownDescription": "507 Insufficient Storage\n\nIndicates that the server is unable to store the representation needed to complete the request.\n\nThe server cannot store the representation required to complete the request, typically due to storage space limitations.\n\nUsed in WebDAV environments when there's insufficient storage space, when the server cannot allocate storage for the request, or when storage quotas are exceeded. Common in file management systems and collaborative editing platforms.\n\nThe server cannot store the required representation. The client should check storage availability and retry the request." + }, + "508": { + "$ref": "#/definitions/Response", + "description": "508 Loop Detected\n\nIndicates that the server detected an infinite loop while processing the request.\n\nThe server detected an infinite loop in the request processing, typically in WebDAV operations.\n\nUsed in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios.\n\nThe server detected an infinite loop. The client should check the request for circular references and retry.", + "markdownDescription": "508 Loop Detected\n\nIndicates that the server detected an infinite loop while processing the request.\n\nThe server detected an infinite loop in the request processing, typically in WebDAV operations.\n\nUsed in WebDAV environments when there are infinite loops in request processing, when there are circular references in operations, or when the server detects recursive operations. Common in file management systems and collaborative editing scenarios.\n\nThe server detected an infinite loop. The client should check the request for circular references and retry." + }, + "510": { + "$ref": "#/definitions/Response", + "description": "510 Not Extended — OBSOLETED\n\nThis status code is obsolete and should not be used in modern implementations.\n\nThis status code was used for HTTP extensions but is now obsolete and should not be used.\n\nNot used in modern web applications. This code is obsolete and should not be implemented.\n\nThis status code should not be encountered in modern web applications.", + "markdownDescription": "510 Not Extended — OBSOLETED\n\nThis status code is obsolete and should not be used in modern implementations.\n\nThis status code was used for HTTP extensions but is now obsolete and should not be used.\n\nNot used in modern web applications. This code is obsolete and should not be implemented.\n\nThis status code should not be encountered in modern web applications." + }, + "511": { + "$ref": "#/definitions/Response", + "description": "511 Network Authentication Required\n\nIndicates that the client needs to authenticate to gain network access.\n\nThe client must authenticate with the network before it can access the requested resource.\n\nUsed in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication.\n\nThe client needs to authenticate with the network. The client should follow the authentication process provided by the network.", + "markdownDescription": "511 Network Authentication Required\n\nIndicates that the client needs to authenticate to gain network access.\n\nThe client must authenticate with the network before it can access the requested resource.\n\nUsed in captive portal scenarios, public Wi-Fi networks, or when network-level authentication is required. Common in public networks, hotels, airports, and other locations where network access requires authentication.\n\nThe client needs to authenticate with the network. The client should follow the authentication process provided by the network." + }, + "1xx": { + "$ref": "#/definitions/Response", + "description": "1xx — Informational\n\nIndicates that the request was received and the server is continuing to process it.\n\nUsed for provisional responses that indicate the server has received the request and is continuing to process it. These responses are typically used for status updates during long-running operations or to indicate that the server is ready to receive additional data.\n\nThe client should continue waiting for the final response. These are provisional responses and the client should not consider the request complete until receiving a final status code.", + "markdownDescription": "1xx — Informational\n\nIndicates that the request was received and the server is continuing to process it.\n\nUsed for provisional responses that indicate the server has received the request and is continuing to process it. These responses are typically used for status updates during long-running operations or to indicate that the server is ready to receive additional data.\n\nThe client should continue waiting for the final response. These are provisional responses and the client should not consider the request complete until receiving a final status code." + }, + "2xx": { + "$ref": "#/definitions/Response", + "description": "2xx — Success\n\nIndicates that the request was successfully received, understood, and accepted.\n\nUsed for successful operations where the request was processed successfully and the response contains the requested data or indicates successful completion of the operation.\n\nThe operation completed successfully. The response body typically contains the requested data or confirmation of the successful operation.", + "markdownDescription": "2xx — Success\n\nIndicates that the request was successfully received, understood, and accepted.\n\nUsed for successful operations where the request was processed successfully and the response contains the requested data or indicates successful completion of the operation.\n\nThe operation completed successfully. The response body typically contains the requested data or confirmation of the successful operation." + }, + "3xx": { + "$ref": "#/definitions/Response", + "description": "3xx — Redirection\n\nIndicates that further action needs to be taken by the client to complete the request.\n\nUsed when the client needs to take additional action to complete the request, such as following a redirect, providing authentication, or accessing the resource at a different location.\n\nThe client needs to take additional action to complete the request. This may involve following a redirect, providing authentication, or accessing the resource at a different location.", + "markdownDescription": "3xx — Redirection\n\nIndicates that further action needs to be taken by the client to complete the request.\n\nUsed when the client needs to take additional action to complete the request, such as following a redirect, providing authentication, or accessing the resource at a different location.\n\nThe client needs to take additional action to complete the request. This may involve following a redirect, providing authentication, or accessing the resource at a different location." + }, + "4xx": { + "$ref": "#/definitions/Response", + "description": "4xx — Client Error\n\nIndicates that the request contains bad syntax or cannot be fulfilled by the server.\n\nUsed when the client has sent an invalid request, such as malformed syntax, invalid parameters, authentication failures, or requests for non-existent resources.\n\nThe client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request.", + "markdownDescription": "4xx — Client Error\n\nIndicates that the request contains bad syntax or cannot be fulfilled by the server.\n\nUsed when the client has sent an invalid request, such as malformed syntax, invalid parameters, authentication failures, or requests for non-existent resources.\n\nThe client has sent an invalid request and should fix the request before retrying. The response body should contain details about what was wrong with the request." + }, + "5xx": { + "$ref": "#/definitions/Response", + "description": "5xx — Server Error\n\nIndicates that the server failed to fulfill a valid request.\n\nUsed when the server encounters an error while processing a valid request, such as internal server errors, service unavailability, or gateway timeouts.\n\nThe server encountered an error while processing the request. The client should retry the request later, as this is typically a temporary issue.", + "markdownDescription": "5xx — Server Error\n\nIndicates that the server failed to fulfill a valid request.\n\nUsed when the server encounters an error while processing a valid request, such as internal server errors, service unavailability, or gateway timeouts.\n\nThe server encountered an error while processing the request. The client should retry the request later, as this is typically a temporary issue." + }, + "default": { + "$ref": "#/definitions/Response", + "description": "default — The default response for all codes not covered individually.", + "markdownDescription": "default — The default response for all codes not covered individually." + } + }, + "additionalProperties": false, + "description": "Swagger 2.0 Valid HTTP Status Codes\n\nEnumerates individual HTTP status codes (as keys) plus the special `\"default\"` key, per the IANA HTTP Status Code Registry. JSDoc reason phrases and references mirror the registry entries. See also RFC 9110 (HTTP Semantics) section mappings.", + "markdownDescription": "Swagger 2.0 Valid HTTP Status Codes\n\nEnumerates individual HTTP status codes (as keys) plus the special `\"default\"` key,\nper the IANA HTTP Status Code Registry. JSDoc reason phrases and references mirror\nthe registry entries. See also RFC 9110 (HTTP Semantics) section mappings." + }, + "Response": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response Object - description } |", + "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\nThis field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response Object - description } |", + "examples": [ + "User successfully retrieved", + "Bad request - invalid input parameters", + "Internal server error" + ] + }, + "headers": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Header" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response Object - headers } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response Object - headers } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response Object - headers } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response Object - headers } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response Object - headers } |", + "markdownDescription": "Maps a header name to its definition. RFC7230 states header names are case insensitive.\nIf a response header is defined with the name \"Content-Type\", it SHALL be ignored.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response Object - headers } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response Object - headers } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response Object - headers } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response Object - headers } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response Object - headers } |", + "examples": [ + { + "X-RateLimit-Limit": { + "schema": { + "type": "integer" + } + } + } + ] + }, + "content": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MediaType" + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response Object - content } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response Object - content } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response Object - content } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response Object - content } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response Object - content } |", + "markdownDescription": "A map containing descriptions of potential response payloads. The key is a media type\nor media type range and the value describes it. For responses that match multiple keys,\nonly the most specific key is applicable.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response Object - content } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response Object - content } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response Object - content } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response Object - content } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response Object - content } |", + "examples": [ + { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + ] + }, + "links": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Link" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response Object - links } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response Object - links } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response Object - links } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response Object - links } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response Object - links } |", + "markdownDescription": "A map of operations links that can be followed from the response. The key of the map\nis a short name for the link, following the naming constraints of the names for Component Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response Object - links } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response Object - links } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response Object - links } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response Object - links } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response Object - links } |", + "examples": [ + { + "GetUserByUserId": { + "operationId": "getUserById", + "parameters": { + "userId": "$response.body#/id" + } + } + } + ] + } + }, + "required": ["description"], + "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" + }, + "Link": { + "type": "object", + "properties": { + "operationRef": { + "type": "string", + "description": "A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationRef } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationRef } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationRef } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationRef } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationRef } |", + "markdownDescription": "A relative or absolute reference to an OAS operation. This field is mutually\nexclusive of the operationId field, and MUST point to an Operation Object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationRef } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationRef } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationRef } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationRef } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationRef } |", + "examples": [ + "#/paths/~12.0~1repositories~1{username}/get", + "https://na2.gigantic-server.com/#/paths/~12.0~1repositories~1{username}/get" + ] + }, + "operationId": { + "type": "string", + "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", + "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", + "examples": ["getUserById", "createPet"] + }, + "parameters": { + "type": "object", + "additionalProperties": {}, + "description": "A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - parameters } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - parameters } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - parameters } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - parameters } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - parameters } |", + "markdownDescription": "A map representing parameters to pass to an operation as specified with operationId\nor identified via operationRef. The key is the parameter name to be used, whereas\nthe value can be a constant or an expression to be evaluated and passed to the linked operation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - parameters } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - parameters } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - parameters } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - parameters } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - parameters } |", + "examples": [ + { + "userId": "$response.body#/id" + }, + { + "limit": 10 + } + ] + }, + "requestBody": { + "description": "A literal value or expression to use as a request body when calling the target operation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - requestBody } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - requestBody } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - requestBody } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - requestBody } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - requestBody } |", + "markdownDescription": "A literal value or expression to use as a request body when calling the target operation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - requestBody } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - requestBody } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - requestBody } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - requestBody } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - requestBody } |", + "examples": [ + { + "name": "John Doe" + }, + "$request.body#/user" + ] + }, + "description": { + "type": "string", + "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", + "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", + "examples": ["Get user by ID", "Create a new pet"] + }, + "server": { + "$ref": "#/definitions/Server", + "description": "A server object to be used by the target operation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - server } |", + "markdownDescription": "A server object to be used by the target operation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - server } |", + "examples": [ + { + "url": "https://api.example.com/v1" + } + ] + } + }, + "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response.\nThe presence of a link does not guarantee the caller's ability to successfully invoke it,\nrather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link } |\n\n-----\nFields\n-----" + }, + "Callback": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/PathItem" + }, + "description": "----- Callback Object\n-----\n\nA map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses.\n\nThe key that identifies the Path Item Object is a runtime expression that can be evaluated in the context of a runtime HTTP request/response to identify the URL to be used for the callback request. A simple example might be `$request.body#/id`. A more complex example that uses a number of runtime expressions is `$request.body#/url~1callback`.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#callback-object OpenAPI 3.0.4 Callback } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#callback-object OpenAPI 3.0.3 Callback } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#callback-object OpenAPI 3.0.2 Callback } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#callback-object OpenAPI 3.0.1 Callback } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#callback-object OpenAPI 3.0.0 Callback } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nCallback Object\n-----\n\nA map of possible out-of band callbacks related to the parent operation.\nEach value in the map is a Path Item Object that describes a set of requests\nthat may be initiated by the API provider and the expected responses.\n\nThe key that identifies the Path Item Object is a runtime expression that can be\nevaluated in the context of a runtime HTTP request/response to identify the URL\nto be used for the callback request. A simple example might be `$request.body#/id`.\nA more complex example that uses a number of runtime expressions is\n`$request.body#/url~1callback`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#callback-object OpenAPI 3.0.4 Callback } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#callback-object OpenAPI 3.0.3 Callback } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#callback-object OpenAPI 3.0.2 Callback } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#callback-object OpenAPI 3.0.1 Callback } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#callback-object OpenAPI 3.0.0 Callback } |\n\n-----\nFields\n-----" + }, + "SecurityRequirement": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes to execute this operation.\n\nThe Security Requirement Object lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-requirement-object OpenAPI 3.0.4 Security Requirement } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-requirement-object OpenAPI 3.0.3 Security Requirement } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-requirement-object OpenAPI 3.0.2 Security Requirement } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-requirement-object OpenAPI 3.0.1 Security Requirement } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-requirement-object OpenAPI 3.0.0 Security Requirement } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes to execute this operation.\n\nThe Security Requirement Object lists the required security schemes to execute\nthis operation. The name used for each property MUST correspond to a security\nscheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-requirement-object OpenAPI 3.0.4 Security Requirement } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-requirement-object OpenAPI 3.0.3 Security Requirement } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-requirement-object OpenAPI 3.0.2 Security Requirement } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-requirement-object OpenAPI 3.0.1 Security Requirement } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-requirement-object OpenAPI 3.0.0 Security Requirement } |\n\n-----\nFields\n-----" + }, + "Components": { + "type": "object", + "properties": { + "schemas": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Schema" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Schema Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - schemas } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - schemas } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - schemas } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - schemas } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - schemas } |", + "markdownDescription": "An object to hold reusable Schema Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - schemas } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - schemas } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - schemas } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - schemas } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - schemas } |", + "examples": [ + { + "User": { + "type": "object", + "properties": { + "id": { + "type": "integer" + } + } + } + } + ] + }, + "responses": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Response" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Response Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - responses } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - responses } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - responses } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - responses } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - responses } |", + "markdownDescription": "An object to hold reusable Response Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - responses } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - responses } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - responses } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - responses } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - responses } |", + "examples": [ + { + "NotFound": { + "description": "Resource not found" + } + } + ] + }, + "parameters": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Parameter" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Parameter Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - parameters } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - parameters } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - parameters } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - parameters } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - parameters } |", + "markdownDescription": "An object to hold reusable Parameter Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - parameters } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - parameters } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - parameters } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - parameters } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - parameters } |", + "examples": [ + { + "LimitParam": { + "name": "limit", + "in": "query", + "schema": { + "type": "integer" + } + } + } + ] + }, + "examples": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Example" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Example Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - examples } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - examples } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - examples } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - examples } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - examples } |", + "markdownDescription": "An object to hold reusable Example Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - examples } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - examples } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - examples } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - examples } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - examples } |", + "examples": [ + { + "UserExample": { + "summary": "A user example", + "value": { + "id": 1, + "name": "John" + } + } + } + ] + }, + "requestBodies": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/RequestBody" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Request Body Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - requestBodies } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - requestBodies } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - requestBodies } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - requestBodies } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - requestBodies } |", + "markdownDescription": "An object to hold reusable Request Body Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - requestBodies } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - requestBodies } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - requestBodies } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - requestBodies } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - requestBodies } |", + "examples": [ + { + "UserRequest": { + "description": "User data", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/User" + } + } + } + } + } + ] + }, + "headers": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Header" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Header Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - headers } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - headers } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - headers } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - headers } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - headers } |", + "markdownDescription": "An object to hold reusable Header Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - headers } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - headers } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - headers } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - headers } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - headers } |", + "examples": [ + { + "RateLimit": { + "description": "Rate limit header", + "schema": { + "type": "integer" + } + } + } + ] + }, + "securitySchemes": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/SecurityScheme" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Security Scheme Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - securitySchemes } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - securitySchemes } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - securitySchemes } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - securitySchemes } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - securitySchemes } |", + "markdownDescription": "An object to hold reusable Security Scheme Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - securitySchemes } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - securitySchemes } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - securitySchemes } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - securitySchemes } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - securitySchemes } |", + "examples": [ + { + "ApiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "X-API-Key" + } + } + ] + }, + "links": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Link" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Link Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - links } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - links } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - links } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - links } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - links } |", + "markdownDescription": "An object to hold reusable Link Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - links } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - links } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - links } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - links } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - links } |", + "examples": [ + { + "UserRepositories": { + "operationId": "getUserRepositories", + "parameters": { + "username": "$response.body#/username" + } + } + } + ] + }, + "callbacks": { + "type": "object", + "additionalProperties": { + "anyOf": [ + { + "$ref": "#/definitions/Callback" + }, + { + "$ref": "#/definitions/Reference" + } + ] + }, + "description": "An object to hold reusable Callback Objects.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - callbacks } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - callbacks } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - callbacks } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - callbacks } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - callbacks } |", + "markdownDescription": "An object to hold reusable Callback Objects.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object - callbacks } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object - callbacks } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object - callbacks } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object - callbacks } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object - callbacks } |", + "examples": [ + { + "MyCallback": { + "{$request.body#/callbackUrl}": { + "post": { + "requestBody": { + "$ref": "#/components/requestBodies/SomeRequestBody" + } + } + } + } + } + ] + } + }, + "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#components-object OpenAPI 3.0.0 Components Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#components-object OpenAPI 3.0.1 Components Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#components-object OpenAPI 3.0.2 Components Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#components-object OpenAPI 3.0.3 Components Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#components-object OpenAPI 3.0.4 Components Object } |\n\n-----\nFields\n-----" + }, + "SecurityScheme": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], + "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", + "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] + }, + "description": { + "type": "string", + "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", + "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", + "examples": ["API key authentication", "OAuth 2.0 authentication"] + }, + "name": { + "type": "string", + "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", + "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", + "examples": ["X-API-Key", "Authorization"] + }, + "in": { + "type": "string", + "enum": ["query", "header", "cookie"], + "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", + "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", + "examples": ["query", "header", "cookie"] + }, + "scheme": { + "type": "string", + "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", + "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", + "examples": ["bearer", "basic"] + }, + "bearerFormat": { + "type": "string", + "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", + "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", + "examples": ["JWT", "Bearer"] + }, + "flows": { + "$ref": "#/definitions/OAuthFlows", + "description": "An object containing configuration information for the flow types supported.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - flows } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - flows } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - flows } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - flows } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - flows } |", + "markdownDescription": "An object containing configuration information for the flow types supported.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - flows } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - flows } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - flows } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - flows } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - flows } |", + "examples": [ + { + "authorizationCode": { + "authorizationUrl": "https://example.com/oauth/authorize", + "tokenUrl": "https://example.com/oauth/token" + } + } + ] + }, + "openIdConnectUrl": { + "type": "string", + "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", + "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", + "examples": ["https://example.com/.well-known/openid_configuration"] + } + }, + "required": ["type"], + "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" + }, + "OAuthFlows": { + "type": "object", + "properties": { + "implicit": { + "$ref": "#/definitions/OAuthFlow", + "description": "Configuration for the OAuth Implicit flow.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows Object - implicit } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows Object - implicit } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows Object - implicit } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows Object - implicit } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows Object - implicit } |", + "markdownDescription": "Configuration for the OAuth Implicit flow.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows Object - implicit } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows Object - implicit } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows Object - implicit } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows Object - implicit } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows Object - implicit } |", + "examples": [ + { + "authorizationUrl": "https://example.com/oauth/authorize", + "scopes": { + "read": "Read access" + } + } + ] + }, + "password": { + "$ref": "#/definitions/OAuthFlow", + "description": "Configuration for the OAuth Resource Owner Password flow.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows Object - password } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows Object - password } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows Object - password } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows Object - password } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows Object - password } |", + "markdownDescription": "Configuration for the OAuth Resource Owner Password flow.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows Object - password } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows Object - password } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows Object - password } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows Object - password } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows Object - password } |", + "examples": [ + { + "tokenUrl": "https://example.com/oauth/token", + "scopes": { + "read": "Read access" + } + } + ] + }, + "clientCredentials": { + "$ref": "#/definitions/OAuthFlow", + "description": "Configuration for the OAuth Client Credentials flow.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows Object - clientCredentials } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows Object - clientCredentials } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows Object - clientCredentials } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows Object - clientCredentials } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows Object - clientCredentials } |", + "markdownDescription": "Configuration for the OAuth Client Credentials flow.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows Object - clientCredentials } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows Object - clientCredentials } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows Object - clientCredentials } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows Object - clientCredentials } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows Object - clientCredentials } |", + "examples": [ + { + "tokenUrl": "https://example.com/oauth/token", + "scopes": { + "read": "Read access" + } + } + ] + }, + "authorizationCode": { + "$ref": "#/definitions/OAuthFlow", + "description": "Configuration for the OAuth Authorization Code flow.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows Object - authorizationCode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows Object - authorizationCode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows Object - authorizationCode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows Object - authorizationCode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows Object - authorizationCode } |", + "markdownDescription": "Configuration for the OAuth Authorization Code flow.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows Object - authorizationCode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows Object - authorizationCode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows Object - authorizationCode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows Object - authorizationCode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows Object - authorizationCode } |", + "examples": [ + { + "authorizationUrl": "https://example.com/oauth/authorize", + "tokenUrl": "https://example.com/oauth/token", + "scopes": { + "read": "Read access" + } + } + ] + } + }, + "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\nThe OAuth Flows Object allows configuration of the supported OAuth Flows. Each property represents a specific OAuth flow type and contains configuration details for that flow.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\nThe OAuth Flows Object allows configuration of the supported OAuth Flows. Each property\nrepresents a specific OAuth flow type and contains configuration details for that flow.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flows-object OpenAPI 3.0.4 OAuth Flows } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flows-object OpenAPI 3.0.3 OAuth Flows } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flows-object OpenAPI 3.0.2 OAuth Flows } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flows-object OpenAPI 3.0.1 OAuth Flows } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flows-object OpenAPI 3.0.0 OAuth Flows } |\n\n-----\nFields\n-----" + }, + "OAuthFlow": { + "type": "object", + "properties": { + "authorizationUrl": { + "type": "string", + "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - authorizationUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - authorizationUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - authorizationUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - authorizationUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - authorizationUrl } |", + "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - authorizationUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - authorizationUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - authorizationUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - authorizationUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - authorizationUrl } |", + "examples": [ + "https://example.com/oauth/authorize", + "https://api.example.com/oauth/authorize" + ] + }, + "tokenUrl": { + "type": "string", + "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", + "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] + }, + "refreshUrl": { + "type": "string", + "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", + "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] + }, + "scopes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - scopes } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - scopes } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - scopes } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - scopes } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - scopes } |", + "markdownDescription": "The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - scopes } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - scopes } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - scopes } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - scopes } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - scopes } |", + "examples": [ + { + "read": "Read access", + "write": "Write access" + }, + { + "admin": "Administrative access" + } + ] + } + }, + "required": ["scopes"], + "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" + }, + "Tag": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", + "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", + "examples": ["users", "pets", "authentication"] + }, + "description": { + "type": "string", + "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", + "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", + "examples": ["User management operations", "Pet store operations"] + }, + "externalDocs": { + "$ref": "#/definitions/ExternalDocumentation", + "description": "Additional external documentation for this tag.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - externalDocs } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - externalDocs } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - externalDocs } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - externalDocs } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - externalDocs } |", + "markdownDescription": "Additional external documentation for this tag.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - externalDocs } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - externalDocs } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - externalDocs } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - externalDocs } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - externalDocs } |", + "examples": [ + { + "description": "Find out more about user management", + "url": "https://example.com/docs/users" + } + ] + } + }, + "required": ["name"], + "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", + "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" + } + } +} diff --git a/schemas/3.0/components/requestbody.json b/schemas/3.0/components/requestbody.json index ae44346..f14097b 100644 --- a/schemas/3.0/components/requestbody.json +++ b/schemas/3.0/components/requestbody.json @@ -6,10 +6,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -32,15 +29,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----", "definitions": { @@ -49,13 +42,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -111,10 +98,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -147,11 +131,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -162,10 +142,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -180,10 +157,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -211,16 +185,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -231,28 +199,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -265,11 +224,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -282,9 +237,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1629,10 +1582,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1653,9 +1603,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1670,26 +1618,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1701,9 +1638,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1735,17 +1670,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -1927,24 +1858,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -1969,10 +1889,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2063,9 +1980,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2083,10 +1998,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2107,9 +2019,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2120,24 +2030,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2148,64 +2050,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2234,19 +2110,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2266,10 +2136,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2312,10 +2179,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2366,15 +2230,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2386,56 +2245,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2445,34 +2285,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2501,42 +2329,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2547,46 +2362,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2600,54 +2400,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2657,36 +2440,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2715,61 +2484,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2781,54 +2530,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2838,36 +2570,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2896,61 +2614,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2962,45 +2660,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -3009,29 +2693,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3060,15 +2735,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3080,40 +2751,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3121,15 +2778,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3142,24 +2792,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3167,18 +2805,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3207,9 +2841,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3229,33 +2861,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3267,18 +2889,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3349,18 +2966,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3389,19 +3002,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3433,15 +3041,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3497,24 +3097,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3525,11 +3117,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3550,9 +3138,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3564,10 +3150,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3604,33 +3187,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3659,19 +3231,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3687,9 +3254,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3755,10 +3320,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3807,9 +3369,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3902,11 +3462,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -3934,36 +3490,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -3976,55 +3518,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4049,10 +3574,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4105,10 +3627,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4131,15 +3650,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4581,9 +4096,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4603,10 +4116,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4636,10 +4146,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -4918,71 +4425,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -5001,14 +4478,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5088,19 +4561,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5120,9 +4587,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5133,20 +4598,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5160,11 +4618,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/response.json b/schemas/3.0/components/response.json index 29aec9d..e67979e 100644 --- a/schemas/3.0/components/response.json +++ b/schemas/3.0/components/response.json @@ -79,9 +79,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----", "definitions": { @@ -90,13 +88,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -152,10 +144,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -188,11 +177,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -203,10 +188,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -221,10 +203,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -252,16 +231,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -272,28 +245,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -306,11 +270,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -323,9 +283,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1670,10 +1628,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1694,9 +1649,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1711,26 +1664,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1742,9 +1684,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1776,17 +1716,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -1968,24 +1904,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -2010,10 +1935,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2104,9 +2026,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2124,10 +2044,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2148,9 +2065,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2161,24 +2076,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2189,64 +2096,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2275,19 +2156,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2307,10 +2182,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2353,10 +2225,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2407,15 +2276,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2427,56 +2291,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2486,34 +2331,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2542,42 +2375,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2588,46 +2408,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2641,54 +2446,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2698,36 +2486,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2756,61 +2530,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2822,54 +2576,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2879,36 +2616,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2937,61 +2660,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3003,45 +2706,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -3050,29 +2739,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3101,15 +2781,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3121,40 +2797,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3162,15 +2824,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3183,24 +2838,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3208,18 +2851,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3248,9 +2887,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3270,33 +2907,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3308,18 +2935,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3390,18 +3012,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3430,19 +3048,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3474,15 +3087,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3538,24 +3143,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3566,11 +3163,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3591,9 +3184,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3605,10 +3196,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3645,33 +3233,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3700,19 +3277,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3728,9 +3300,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3796,10 +3366,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3848,9 +3415,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3943,11 +3508,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -3975,36 +3536,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -4017,55 +3564,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4090,10 +3620,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4146,10 +3673,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4172,15 +3696,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4622,9 +4142,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4644,10 +4162,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4677,10 +4192,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -4959,71 +4471,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -5042,14 +4524,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5129,19 +4607,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5161,9 +4633,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5174,20 +4644,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5201,11 +4664,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/schema.json b/schemas/3.0/components/schema.json index 1431387..7a5de1d 100644 --- a/schemas/3.0/components/schema.json +++ b/schemas/3.0/components/schema.json @@ -34,13 +34,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -96,10 +90,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -132,11 +123,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -147,10 +134,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -165,10 +149,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -196,16 +177,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -216,28 +191,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -250,11 +216,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -267,9 +229,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1614,10 +1574,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1638,9 +1595,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1655,26 +1610,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1686,9 +1630,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1720,17 +1662,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -1912,24 +1850,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -1954,10 +1881,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2048,9 +1972,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2068,10 +1990,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2092,9 +2011,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2105,24 +2022,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2133,64 +2042,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2219,19 +2102,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2251,10 +2128,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2297,10 +2171,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2351,15 +2222,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2371,56 +2237,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2430,34 +2277,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2486,42 +2321,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2532,46 +2354,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2585,54 +2392,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2642,36 +2432,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2700,61 +2476,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2766,54 +2522,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2823,36 +2562,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2881,61 +2606,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2947,45 +2652,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -2994,29 +2685,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3045,15 +2727,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3065,40 +2743,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3106,15 +2770,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3127,24 +2784,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3152,18 +2797,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3192,9 +2833,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3214,33 +2853,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3252,18 +2881,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3334,18 +2958,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3374,19 +2994,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3418,15 +3033,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3482,24 +3089,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3510,11 +3109,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3535,9 +3130,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3549,10 +3142,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3589,33 +3179,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3644,19 +3223,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3672,9 +3246,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3740,10 +3312,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3792,9 +3361,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3887,11 +3454,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -3919,36 +3482,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -3961,55 +3510,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4034,10 +3566,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4090,10 +3619,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4116,15 +3642,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4566,9 +4088,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4588,10 +4108,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4621,10 +4138,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -4903,71 +4417,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -4986,14 +4470,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5073,19 +4553,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5105,9 +4579,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5118,20 +4590,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5145,11 +4610,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/components/securityscheme.json b/schemas/3.0/components/securityscheme.json index 18f5b35..1450268 100644 --- a/schemas/3.0/components/securityscheme.json +++ b/schemas/3.0/components/securityscheme.json @@ -4,71 +4,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -87,14 +57,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----", "definitions": { @@ -103,13 +69,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -165,10 +125,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -201,11 +158,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -216,10 +169,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -234,10 +184,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -265,16 +212,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -285,28 +226,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -319,11 +251,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -336,9 +264,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1683,10 +1609,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1707,9 +1630,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1724,26 +1645,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1755,9 +1665,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1789,17 +1697,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -1981,24 +1885,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -2023,10 +1916,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2117,9 +2007,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2137,10 +2025,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2161,9 +2046,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2174,24 +2057,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2202,64 +2077,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2288,19 +2137,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2320,10 +2163,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2366,10 +2206,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2420,15 +2257,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2440,56 +2272,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2499,34 +2312,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2555,42 +2356,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2601,46 +2389,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2654,54 +2427,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2711,36 +2467,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2769,61 +2511,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2835,54 +2557,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2892,36 +2597,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2950,61 +2641,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3016,45 +2687,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -3063,29 +2720,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3114,15 +2762,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3134,40 +2778,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3175,15 +2805,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3196,24 +2819,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3221,18 +2832,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3261,9 +2868,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3283,33 +2888,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3321,18 +2916,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3403,18 +2993,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3443,19 +3029,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3487,15 +3068,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3551,24 +3124,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3579,11 +3144,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3604,9 +3165,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3618,10 +3177,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3658,33 +3214,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3713,19 +3258,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3741,9 +3281,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3809,10 +3347,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3861,9 +3396,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3956,11 +3489,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -3988,36 +3517,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -4030,55 +3545,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4103,10 +3601,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4159,10 +3654,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4185,15 +3677,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4635,9 +4123,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4657,10 +4143,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4690,10 +4173,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -4972,71 +4452,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -5055,14 +4505,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5142,19 +4588,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5174,9 +4614,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5187,20 +4625,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5214,11 +4645,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.0/index.ts b/schemas/3.0/index.ts index 662fcee..e56c085 100644 --- a/schemas/3.0/index.ts +++ b/schemas/3.0/index.ts @@ -46,4 +46,3 @@ export const schemas = { callback, pathitem, } as const; - diff --git a/schemas/3.0/main/specification.json b/schemas/3.0/main/specification.json index f4d89c1..b28caee 100644 --- a/schemas/3.0/main/specification.json +++ b/schemas/3.0/main/specification.json @@ -4,13 +4,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -66,10 +60,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -102,11 +93,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----", "definitions": { @@ -115,13 +102,7 @@ "properties": { "openapi": { "type": "string", - "enum": [ - "3.0.0", - "3.0.1", - "3.0.2", - "3.0.3", - "3.0.4" - ], + "enum": ["3.0.0", "3.0.1", "3.0.2", "3.0.3", "3.0.4"], "description": "Specifies the OpenAPI specification version being used. Must be \"3.0.0\" for this specification.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |", "markdownDescription": "Specifies the OpenAPI specification version being used.\nMust be \"3.0.0\" for this specification.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 Specification - openapi } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 Specification - openapi } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 Specification - openapi } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 Specification - openapi } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 Specification - openapi } |" }, @@ -177,10 +158,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -213,11 +191,7 @@ ] } }, - "required": [ - "info", - "openapi", - "paths" - ], + "required": ["info", "openapi", "paths"], "description": "----- OpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains all the metadata about the API being described. This object is based on the JSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains all the information about the API, including its metadata, available paths, data models, security schemes, and more.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Object\n-----\n\nRoot OpenAPI 3.0 Schema (OpenAPI Object)\n\nThis is the root document object of the OpenAPI specification. It contains\nall the metadata about the API being described. This object is based on the\nJSON Schema Specification Wright Draft 00 and uses a predefined subset of it.\n\nThe OpenAPI Object is the root of the specification document and contains\nall the information about the API, including its metadata, available paths,\ndata models, security schemes, and more.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#openapi-object OpenAPI 3.0.4 OpenAPI Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#openapi-object OpenAPI 3.0.3 OpenAPI Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#openapi-object OpenAPI 3.0.2 OpenAPI Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#openapi-object OpenAPI 3.0.1 OpenAPI Object } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#openapi-object OpenAPI 3.0.0 OpenAPI Object } |\n\n-----\nFields\n-----" }, @@ -228,10 +202,7 @@ "type": "string", "description": "The title of the application. This field is required.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", "markdownDescription": "The title of the application. This field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - title } |", - "examples": [ - "Sample Pet Store App", - "My API" - ] + "examples": ["Sample Pet Store App", "My API"] }, "description": { "type": "string", @@ -246,10 +217,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/", - "https://example.com/terms" - ] + "examples": ["http://example.com/terms/", "https://example.com/terms"] }, "contact": { "$ref": "#/definitions/Contact", @@ -277,16 +245,10 @@ "type": "string", "description": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document (which is distinct from the OpenAPI Specification version\nor the API implementation version). This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info Object - version } |", - "examples": [ - "1.0.1", - "2.0.0" - ] + "examples": ["1.0.1", "2.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by clients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API.\nThe metadata MAY be used by the clients if needed, and MAY be presented in\nediting or documentation generation tools for convenience.\n\nThe Info Object provides metadata about the API. This metadata can be used by\nclients if needed, and can be presented in the OpenAPI-UI for convenience.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#info-object OpenAPI 3.0.4 Info } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#info-object OpenAPI 3.0.3 Info } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#info-object OpenAPI 3.0.2 Info } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#info-object OpenAPI 3.0.1 Info } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#info-object OpenAPI 3.0.0 Info } |\n\n-----\nFields\n-----" }, @@ -297,28 +259,19 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - url } |", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact Object - email } |", - "examples": [ - "support@example.com", - "contact@example.com" - ] + "examples": ["support@example.com", "contact@example.com"] } }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\nThe Contact Object provides contact information for the exposed API. It can include the name, URL, and email address of the contact person or organization.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#contact-object OpenAPI 3.0.4 Contact } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#contact-object OpenAPI 3.0.3 Contact } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#contact-object OpenAPI 3.0.2 Contact } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#contact-object OpenAPI 3.0.1 Contact } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#contact-object OpenAPI 3.0.0 Contact } |\n\n----- Fields\n-----", @@ -331,11 +284,7 @@ "$ref": "#/definitions/LicenseName", "description": "The license name used for the API. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", "markdownDescription": "The license name used for the API. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License Object - name } |", - "examples": [ - "MIT License", - "Apache 2.0", - "Proprietary License" - ] + "examples": ["MIT License", "Apache 2.0", "Proprietary License"] }, "url": { "$ref": "#/definitions/LicenseURL", @@ -348,9 +297,7 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can include the name of the license and optionally a URL to the license text.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\nThe License Object provides license information for the exposed API. It can\ninclude the name of the license and optionally a URL to the license text.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#license-object OpenAPI 3.0.4 License } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#license-object OpenAPI 3.0.3 License } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#license-object OpenAPI 3.0.2 License } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#license-object OpenAPI 3.0.1 License } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#license-object OpenAPI 3.0.0 License } |\n\n-----\nFields\n-----" }, @@ -1695,10 +1642,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server Object - description } |", - "examples": [ - "Development server", - "Production server" - ] + "examples": ["Development server", "Production server"] }, "variables": { "type": "object", @@ -1719,9 +1663,7 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL, description, and server variables for URL template substitution.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\nThe Server Object represents a server that hosts the API. It can contain a URL,\ndescription, and server variables for URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-object OpenAPI 3.0.4 Server } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-object OpenAPI 3.0.3 Server } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-object OpenAPI 3.0.2 Server } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-object OpenAPI 3.0.1 Server } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-object OpenAPI 3.0.0 Server } |\n\n-----\nFields\n-----" }, @@ -1736,26 +1678,15 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options are from a limited set.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - enum } |", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, and to send, if an alternate value is not supplied.\nUnlike the Schema Object's default, this value MUST be provided by the consumer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable Object - default } |", - "examples": [ - "demo", - "8443", - "v2" - ] + "examples": ["demo", "8443", "v2"] }, "description": { "type": "string", @@ -1767,9 +1698,7 @@ ] } }, - "required": [ - "default" - ], + "required": ["default"], "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template substitution. It can contain an enumeration of values, a default value, and a description.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\nThe Server Variable Object represents a server variable for server URL template\nsubstitution. It can contain an enumeration of values, a default value, and\na description.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#server-variable-object OpenAPI 3.0.4 Server Variable } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#server-variable-object OpenAPI 3.0.3 Server Variable } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#server-variable-object OpenAPI 3.0.2 Server Variable } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#server-variable-object OpenAPI 3.0.1 Server Variable } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#server-variable-object OpenAPI 3.0.0 Server Variable } |\n\n-----\nFields\n-----" }, @@ -1801,17 +1730,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - summary } |", - "examples": [ - "User management operations" - ] + "examples": ["User management operations"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#path-item-object OpenAPI 3.0.4 Path Item Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#path-item-object OpenAPI 3.0.3 Path Item Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#path-item-object OpenAPI 3.0.2 Path Item Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#path-item-object OpenAPI 3.0.1 Path Item Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#path-item-object OpenAPI 3.0.0 Path Item Object - description } |", - "examples": [ - "Operations for managing users in the system" - ] + "examples": ["Operations for managing users in the system"] }, "get": { "$ref": "#/definitions/Operation", @@ -1993,24 +1918,13 @@ }, "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - tags } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - tags } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - tags } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - tags } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - tags } |", - "examples": [ - [ - "users", - "authentication" - ], - [ - "pets" - ] - ] + "examples": [["users", "authentication"], ["pets"]] }, "summary": { "type": "string", "description": "A short summary of what the operation does. For maximum readability in OpenAPI-UI, this field SHOULD be less than 120 characters.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does. For maximum readability in\nOpenAPI-UI, this field SHOULD be less than 120 characters.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - summary } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "description": { "type": "string", @@ -2035,10 +1949,7 @@ "type": "string", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among\nall operations described in the API. Tools and libraries MAY use the\noperationId to uniquely identify an operation, therefore, it is recommended\nto follow common programming naming conventions.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "array", @@ -2129,9 +2040,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage\nof the declared operation. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "security": { @@ -2149,10 +2058,7 @@ ], [ { - "oauth2": [ - "read", - "write" - ] + "oauth2": ["read", "write"] } ] ] @@ -2173,9 +2079,7 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains information about the operation including its parameters, request body, responses, and security requirements.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\nThe Operation Object describes a single API operation on a path. It contains\ninformation about the operation including its parameters, request body, responses,\nand security requirements.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#operation-object OpenAPI 3.0.4 Operation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#operation-object OpenAPI 3.0.3 Operation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#operation-object OpenAPI 3.0.2 Operation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#operation-object OpenAPI 3.0.1 Operation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#operation-object OpenAPI 3.0.0 Operation } |\n\n-----\nFields\n-----" }, @@ -2186,24 +2090,16 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - description } |", - "examples": [ - "Find more info here", - "Additional documentation for this API" - ] + "examples": ["Find more info here", "Additional documentation for this API"] }, "url": { "type": "string", "description": "The URL for the target documentation. MUST be in the format of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", "markdownDescription": "The URL for the target documentation. MUST be in the format of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation Object - url } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation Object - url } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation Object - url } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation Object - url } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation Object - url } |", - "examples": [ - "https://example.com/docs", - "https://api.example.com/documentation" - ] + "examples": ["https://example.com/docs", "https://api.example.com/documentation"] } }, - "required": [ - "url" - ], + "required": ["url"], "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#external-documentation-object OpenAPI 3.0.4 External Documentation } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#external-documentation-object OpenAPI 3.0.3 External Documentation } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#external-documentation-object OpenAPI 3.0.2 External Documentation } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#external-documentation-object OpenAPI 3.0.1 External Documentation } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#external-documentation-object OpenAPI 3.0.0 External Documentation } |\n\n-----\nFields\n-----" }, @@ -2214,64 +2110,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -2300,19 +2170,13 @@ "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2332,10 +2196,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#parameter-object OpenAPI 3.0.4 Parameter Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#parameter-object OpenAPI 3.0.3 Parameter Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#parameter-object OpenAPI 3.0.2 Parameter Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#parameter-object OpenAPI 3.0.1 Parameter Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2378,10 +2239,7 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#parameter-object OpenAPI 3.0.0 Parameter } |\n\n-----\nFields\n-----" }, @@ -2432,15 +2290,10 @@ "type": "string", "description": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the referenced schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "A reference to the User schema", - "Pet object definition" - ] + "examples": ["A reference to the User schema", "Pet object definition"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Schema\n-----\n\nA schema that contains only a reference to another schema definition. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive with all other schema properties except description and extensions.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that contains only a reference to another schema definition.\nWhen a schema contains `$ref`, no other sibling keys are allowed except\n`description` and extensions (`x-...`).\n\nThis enforces the OpenAPI 3.0.x rule that `$ref` is mutually exclusive\nwith all other schema properties except description and extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2452,56 +2305,37 @@ "const": "string", "description": "The type of the schema. Must be \"string\" for string schemas.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", "markdownDescription": "The type of the schema. Must be \"string\" for string schemas.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - type } |", - "examples": [ - "string" - ] + "examples": ["string"] }, "format": { "type": "string", "description": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", "markdownDescription": "The extending format for the string type. See OpenAPI 3.0.x Data Type Formats for details.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - format } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - format } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - format } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - format } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - format } |", - "examples": [ - "email", - "date", - "uuid", - "uri" - ] + "examples": ["email", "date", "uuid", "uri"] }, "title": { "type": "string", "description": "A short title for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", "markdownDescription": "A short title for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - title } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - title } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - title } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - title } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - title } |", - "examples": [ - "User Name", - "Email Address" - ] + "examples": ["User Name", "Email Address"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - description } |", - "examples": [ - "The user's full name", - "Email address in RFC 5322 format" - ] + "examples": ["The user's full name", "Email address in RFC 5322 format"] }, "default": { "type": "string", "description": "The default value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", "markdownDescription": "The default value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - default } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - default } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - default } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - default } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - default } |", - "examples": [ - "John Doe", - "user@example.com" - ] + "examples": ["John Doe", "user@example.com"] }, "example": { "type": "string", "description": "Example value for the schema.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", "markdownDescription": "Example value for the schema.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - example } |", - "examples": [ - "Jane Smith", - "admin@example.com" - ] + "examples": ["Jane Smith", "admin@example.com"] }, "enum": { "type": "array", @@ -2511,34 +2345,22 @@ "description": "Enumeration of valid string values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "markdownDescription": "Enumeration of valid string values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - enum } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - enum } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - enum } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - enum } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - enum } |", "examples": [ - [ - "active", - "inactive", - "pending" - ], - [ - "red", - "green", - "blue" - ] + ["active", "inactive", "pending"], + ["red", "green", "blue"] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", "markdownDescription": "Whether the property is read-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - readOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - readOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - readOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - readOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - readOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", "markdownDescription": "Whether the property is write-only. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - writeOnly } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - writeOnly } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - writeOnly } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - writeOnly } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - writeOnly } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2567,42 +2389,29 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", "markdownDescription": "Whether the schema is deprecated. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - deprecated } |", - "examples": [ - true - ], + "examples": [true], "default": false }, "maxLength": { "type": "number", "description": "Maximum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", "markdownDescription": "Maximum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - maxLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - maxLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - maxLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - maxLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - maxLength } |", - "examples": [ - 100, - 255 - ] + "examples": [100, 255] }, "minLength": { "type": "number", "description": "Minimum length of the string. The value MUST be a non-negative integer.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", "markdownDescription": "Minimum length of the string. The value MUST be a non-negative integer.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - minLength } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - minLength } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - minLength } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - minLength } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - minLength } |", - "examples": [ - 1, - 8 - ] + "examples": [1, 8] }, "pattern": { "type": "string", "description": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", "markdownDescription": "Regular expression pattern the string must match. The pattern MUST be a valid regular expression.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object - pattern } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object - pattern } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object - pattern } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object - pattern } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object - pattern } |", - "examples": [ - "^[a-zA-Z0-9]+$", - "^\\d{4}-\\d{2}-\\d{2}$" - ] + "examples": ["^[a-zA-Z0-9]+$", "^\\d{4}-\\d{2}-\\d{2}$"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- String Schema\n-----\n\nA schema for string data types with string-specific validation constraints. Only valid with `type: \"string\"` and includes string-specific properties like `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string data types with string-specific validation constraints.\nOnly valid with `type: \"string\"` and includes string-specific properties\nlike `maxLength`, `minLength`, and `pattern`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2613,46 +2422,31 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will affect the items within the array.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within items, it will affect the name of the individual XML elements within the list.\nWhen defined alongside type being array (outside the items), it will affect the wrapping element\nand only if wrapped is true. If wrapped is false, it will affect the items within the array.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - name } |", - "examples": [ - "animal", - "item" - ] + "examples": ["animal", "item"] }, "namespace": { "type": "string", "description": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", "markdownDescription": "The URL of the namespace definition. Value SHOULD be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - namespace } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - namespace } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - namespace } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - namespace } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - namespace } |", - "examples": [ - "http://example.com/schema", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", "markdownDescription": "The prefix to be used for the name.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - prefix } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - prefix } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - prefix } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - prefix } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - prefix } |", - "examples": [ - "xs", - "ns" - ] + "examples": ["xs", "ns"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - attribute } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - attribute } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - attribute } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - attribute } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - attribute } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example,\n) or unwrapped (). Default value is false.\nThe definition takes effect only when defined alongside type being array (outside the items).\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML Object - wrapped } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML Object - wrapped } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML Object - wrapped } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML Object - wrapped } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML Object - wrapped } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#xml-object OpenAPI 3.0.4 XML } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#xml-object OpenAPI 3.0.3 XML } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#xml-object OpenAPI 3.0.2 XML } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#xml-object OpenAPI 3.0.1 XML } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#xml-object OpenAPI 3.0.0 XML } |\n\n----- Fields\n-----", @@ -2666,54 +2460,37 @@ "const": "number", "description": "The type of the schema. Must be \"number\" for number schemas.", "markdownDescription": "The type of the schema. Must be \"number\" for number schemas.", - "examples": [ - "number" - ] + "examples": ["number"] }, "format": { "type": "string", "description": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the number type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "float", - "double" - ] + "examples": ["float", "double"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Price", - "Temperature" - ] + "examples": ["Price", "Temperature"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The price in dollars", - "Temperature in Celsius" - ] + "examples": ["The price in dollars", "Temperature in Celsius"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 25.5 - ] + "examples": [0, 25.5] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 19.99, - 98.6 - ] + "examples": [19.99, 98.6] }, "enum": { "type": "array", @@ -2723,36 +2500,22 @@ "description": "Enumeration of valid number values.", "markdownDescription": "Enumeration of valid number values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 0.5, - 1 - ] + [1, 2, 3, 4, 5], + [0, 0.5, 1] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2781,61 +2544,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 0.01, - 0.1, - 2 - ] + "examples": [0.01, 0.1, 2] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 999.99 - ] + "examples": [100, 999.99] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - -273.15 - ] + "examples": [0, -273.15] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -100 - ] + "examples": [0, -100] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Number Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific validation constraints. Only valid with `type: \"number\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for numeric data types (floating-point numbers) with numeric-specific\nvalidation constraints. Only valid with `type: \"number\"` and includes numeric\nproperties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -2847,54 +2590,37 @@ "const": "integer", "description": "The type of the schema. Must be \"integer\" for integer schemas.", "markdownDescription": "The type of the schema. Must be \"integer\" for integer schemas.", - "examples": [ - "integer" - ] + "examples": ["integer"] }, "format": { "type": "string", "description": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", "markdownDescription": "The extending format for the integer type. See OpenAPI 3.0.x Data Type Formats for details.", - "examples": [ - "int32", - "int64" - ] + "examples": ["int32", "int64"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User ID", - "Age" - ] + "examples": ["User ID", "Age"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user's unique identifier", - "Age in years" - ] + "examples": ["The user's unique identifier", "Age in years"] }, "default": { "type": "number", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "example": { "type": "number", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - 42, - 100 - ] + "examples": [42, 100] }, "enum": { "type": "array", @@ -2904,36 +2630,22 @@ "description": "Enumeration of valid integer values.", "markdownDescription": "Enumeration of valid integer values.", "examples": [ - [ - 1, - 2, - 3, - 4, - 5 - ], - [ - 0, - 1, - 2 - ] + [1, 2, 3, 4, 5], + [0, 1, 2] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -2962,61 +2674,41 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "multipleOf": { "type": "number", "description": "A number is valid against \"multipleOf\" if the result of the division of the instance by this keyword's value is an integer.", "markdownDescription": "A number is valid against \"multipleOf\" if the result of the division\nof the instance by this keyword's value is an integer.", - "examples": [ - 1, - 2, - 5 - ] + "examples": [1, 2, 5] }, "maximum": { "type": "number", "description": "A number is valid against \"maximum\" if it is less than or equal to this value.", "markdownDescription": "A number is valid against \"maximum\" if it is less than or equal to this value.", - "examples": [ - 100, - 2147483647 - ] + "examples": [100, 2147483647] }, "exclusiveMaximum": { "type": "number", "description": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", "markdownDescription": "A number is valid against \"exclusiveMaximum\" if it is strictly less than this value.", - "examples": [ - 100, - 1000 - ] + "examples": [100, 1000] }, "minimum": { "type": "number", "description": "A number is valid against \"minimum\" if it is greater than or equal to this value.", "markdownDescription": "A number is valid against \"minimum\" if it is greater than or equal to this value.", - "examples": [ - 0, - 1 - ] + "examples": [0, 1] }, "exclusiveMinimum": { "type": "number", "description": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", "markdownDescription": "A number is valid against \"exclusiveMinimum\" if it is strictly greater than this value.", - "examples": [ - 0, - -1 - ] + "examples": [0, -1] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Integer Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific validation constraints. Only valid with `type: \"integer\"` and includes numeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer data types (whole numbers) with integer-specific\nvalidation constraints. Only valid with `type: \"integer\"` and includes\nnumeric properties like `multipleOf`, `maximum`, `minimum`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3028,45 +2720,31 @@ "const": "boolean", "description": "The type of the schema. Must be \"boolean\" for boolean schemas.", "markdownDescription": "The type of the schema. Must be \"boolean\" for boolean schemas.", - "examples": [ - "boolean" - ] + "examples": ["boolean"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Is Active", - "Enabled" - ] + "examples": ["Is Active", "Enabled"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Whether the user is active", - "Feature enabled status" - ] + "examples": ["Whether the user is active", "Feature enabled status"] }, "default": { "type": "boolean", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "example": { "type": "boolean", "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "enum": { "type": "array", @@ -3075,29 +2753,20 @@ }, "description": "Enumeration of valid boolean values.", "markdownDescription": "Enumeration of valid boolean values.", - "examples": [ - [ - true, - false - ] - ] + "examples": [[true, false]] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3126,15 +2795,11 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Boolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation. Only valid with `type: \"boolean\"` and includes common metadata properties but no boolean-specific validation constraints.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean data types (true/false values) with basic validation.\nOnly valid with `type: \"boolean\"` and includes common metadata properties\nbut no boolean-specific validation constraints.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3146,40 +2811,26 @@ "const": "array", "description": "The type of the schema. Must be \"array\" for array schemas.", "markdownDescription": "The type of the schema. Must be \"array\" for array schemas.", - "examples": [ - "array" - ] + "examples": ["array"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Tags", - "User List" - ] + "examples": ["Tags", "User List"] }, "description": { "type": "string", "description": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Array of tag strings", - "List of user objects" - ] + "examples": ["Array of tag strings", "List of user objects"] }, "default": { "type": "array", "items": {}, "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - [ - "tag1", - "tag2" - ], - [] - ] + "examples": [["tag1", "tag2"], []] }, "example": { "type": "array", @@ -3187,15 +2838,8 @@ "description": "Example value for the schema.", "markdownDescription": "Example value for the schema.", "examples": [ - [ - "example1", - "example2" - ], - [ - 1, - 2, - 3 - ] + ["example1", "example2"], + [1, 2, 3] ] }, "enum": { @@ -3208,24 +2852,12 @@ "markdownDescription": "Enumeration of valid array values.", "examples": [ [ - [ - "a", - "b" - ], - [ - "c", - "d" - ] + ["a", "b"], + ["c", "d"] ], [ - [ - 1, - 2 - ], - [ - 3, - 4 - ] + [1, 2], + [3, 4] ] ] }, @@ -3233,18 +2865,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3273,9 +2901,7 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "items": { @@ -3295,33 +2921,23 @@ "type": "number", "description": "Maximum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 10, - 100 - ] + "examples": [10, 100] }, "minItems": { "type": "number", "description": "Minimum number of items in the array. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of items in the array. The value MUST be a non-negative integer.", - "examples": [ - 1, - 0 - ] + "examples": [1, 0] }, "uniqueItems": { "type": "boolean", "description": "Whether all items in the array must be unique. Default value is false.", "markdownDescription": "Whether all items in the array must be unique. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Array Schema\n-----\n\nA schema for array data types with array-specific validation constraints. Only valid with `type: \"array\"` and includes array properties like `items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array data types with array-specific validation constraints.\nOnly valid with `type: \"array\"` and includes array properties like\n`items`, `maxItems`, `minItems`, and `uniqueItems`.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3333,18 +2949,13 @@ "const": "object", "description": "The type of the schema. Must be \"object\" for object schemas.", "markdownDescription": "The type of the schema. Must be \"object\" for object schemas.", - "examples": [ - "object" - ] + "examples": ["object"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "User", - "Product" - ] + "examples": ["User", "Product"] }, "description": { "type": "string", @@ -3415,18 +3026,14 @@ "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3455,19 +3062,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "properties": { "type": "object", @@ -3499,15 +3101,7 @@ }, "description": "Array of property names that are required. Properties not listed here are optional.", "markdownDescription": "Array of property names that are required. Properties not listed here are optional.", - "examples": [ - [ - "id", - "name" - ], - [ - "email" - ] - ] + "examples": [["id", "name"], ["email"]] }, "additionalProperties": { "anyOf": [ @@ -3563,24 +3157,16 @@ "type": "number", "description": "Maximum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Maximum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 10, - 50 - ] + "examples": [10, 50] }, "minProperties": { "type": "number", "description": "Minimum number of properties in the object. The value MUST be a non-negative integer.", "markdownDescription": "Minimum number of properties in the object. The value MUST be a non-negative integer.", - "examples": [ - 1, - 2 - ] + "examples": [1, 2] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Object Schema\n-----\n\nA schema for object data types with object-specific validation constraints. Only valid with `type: \"object\"` and includes object properties like `properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object data types with object-specific validation constraints.\nOnly valid with `type: \"object\"` and includes object properties like\n`properties`, `required`, `additionalProperties`, etc.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#schema-object OpenAPI 3.0.0 Schema Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#schema-object OpenAPI 3.0.1 Schema Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#schema-object OpenAPI 3.0.2 Schema Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#schema-object OpenAPI 3.0.3 Schema Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#schema-object OpenAPI 3.0.4 Schema Object } |\n\n-----\nFields\n-----" }, @@ -3591,11 +3177,7 @@ "type": "string", "description": "The name of the property in the schema that is used as a discriminator.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", "markdownDescription": "The name of the property in the schema that is used as a discriminator.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object - propertyName } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object - propertyName } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object - propertyName } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object - propertyName } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object - propertyName } |", - "examples": [ - "petType", - "type", - "kind" - ] + "examples": ["petType", "type", "kind"] }, "mapping": { "type": "object", @@ -3616,9 +3198,7 @@ ] } }, - "required": [ - "propertyName" - ], + "required": ["propertyName"], "additionalProperties": false, "description": "----- Discriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nDiscriminator Object\n-----\n\nWhen request bodies or response payloads may be one of a number of different schemas,\na discriminator object can be used to aid in serialization, deserialization, and validation.\nThe discriminator is a specific object in a schema which is used to inform the consumer\nof the specification of an alternative schema based on the value associated with it.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#discriminator-object OpenAPI 3.0.0 Discriminator Object } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#discriminator-object OpenAPI 3.0.1 Discriminator Object } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#discriminator-object OpenAPI 3.0.2 Discriminator Object } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#discriminator-object OpenAPI 3.0.3 Discriminator Object } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#discriminator-object OpenAPI 3.0.4 Discriminator Object } |\n\n-----\nFields\n-----" @@ -3630,10 +3210,7 @@ "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Composed User", - "Flexible Value" - ] + "examples": ["Composed User", "Flexible Value"] }, "description": { "type": "string", @@ -3670,33 +3247,22 @@ "description": "Enumeration of valid values.", "markdownDescription": "Enumeration of valid values.", "examples": [ - [ - "value1", - "value2" - ], - [ - 1, - 2, - 3 - ] + ["value1", "value2"], + [1, 2, 3] ] }, "readOnly": { "type": "boolean", "description": "Whether the property is read-only. Default value is false.", "markdownDescription": "Whether the property is read-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "writeOnly": { "type": "boolean", "description": "Whether the property is write-only. Default value is false.", "markdownDescription": "Whether the property is write-only. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "xml": { @@ -3725,19 +3291,14 @@ "type": "boolean", "description": "Whether the schema is deprecated. Default value is false.", "markdownDescription": "Whether the schema is deprecated. Default value is false.", - "examples": [ - true - ], + "examples": [true], "default": false }, "discriminator": { "$ref": "#/definitions/Discriminator", "description": "Discriminator for polymorphism. The property name used to differentiate between schemas.", "markdownDescription": "Discriminator for polymorphism. The property name used to differentiate between schemas.", - "examples": [ - "petType", - "type" - ] + "examples": ["petType", "type"] }, "allOf": { "type": "array", @@ -3753,9 +3314,7 @@ }, { "type": "object", - "required": [ - "id" - ] + "required": ["id"] } ] ] @@ -3821,10 +3380,7 @@ "type": "string", "description": "Short description for the example.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#example-object OpenAPI 3.0.4 Example Object - summary } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#example-object OpenAPI 3.0.3 Example Object - summary } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#example-object OpenAPI 3.0.2 Example Object - summary } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#example-object OpenAPI 3.0.1 Example Object - summary } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#example-object OpenAPI 3.0.0 Example Object - summary } |", - "examples": [ - "A user example", - "An error response" - ] + "examples": ["A user example", "An error response"] }, "description": { "type": "string", @@ -3873,9 +3429,7 @@ ] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#reference-object OpenAPI 3.0.4 Reference } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#reference-object OpenAPI 3.0.3 Reference } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#reference-object OpenAPI 3.0.2 Reference } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#reference-object OpenAPI 3.0.1 Reference } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#reference-object OpenAPI 3.0.0 Reference } |\n\n-----\nFields\n-----" }, @@ -3968,11 +3522,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the property type.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - contentType } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - contentType } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - contentType } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - contentType } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - contentType } |", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -4000,36 +3550,22 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - style } |", - "examples": [ - "form", - "simple" - ] + "examples": ["form", "simple"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array, or key-value-pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#encoding-object OpenAPI 3.0.4 Encoding Object - allowReserved } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#encoding-object OpenAPI 3.0.3 Encoding Object - allowReserved } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#encoding-object OpenAPI 3.0.2 Encoding Object - allowReserved } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#encoding-object OpenAPI 3.0.1 Encoding Object - allowReserved } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#encoding-object OpenAPI 3.0.0 Encoding } |\n\n----- Fields\n-----", @@ -4042,55 +3578,38 @@ "type": "string", "description": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", "markdownDescription": "A brief description of the header. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - description } |", - "examples": [ - "Rate limit for the current period", - "Content type of the response" - ] + "examples": ["Rate limit for the current period", "Content type of the response"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - deprecated } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - deprecated } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - deprecated } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - deprecated } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - allowEmptyValue } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - allowEmptyValue } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - allowEmptyValue } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - allowEmptyValue } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. The default value is simple.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. The default value is simple.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - style } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - style } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - style } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - style } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. The default value is false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. The default value is false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - explode } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - explode } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - explode } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - explode } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "anyOf": [ @@ -4115,10 +3634,7 @@ "example": { "description": "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.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#header-object OpenAPI 3.0.4 Header Object - example } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#header-object OpenAPI 3.0.3 Header Object - example } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#header-object OpenAPI 3.0.2 Header Object - example } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#header-object OpenAPI 3.0.1 Header Object - example } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#header-object OpenAPI 3.0.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -4171,10 +3687,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - description } |", - "examples": [ - "User data to create", - "Pet information" - ] + "examples": ["User data to create", "Pet information"] }, "content": { "type": "object", @@ -4197,15 +3710,11 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#request-body-object OpenAPI 3.0.4 Request Body Object - required } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#request-body-object OpenAPI 3.0.3 Request Body Object - required } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#request-body-object OpenAPI 3.0.2 Request Body Object - required } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#request-body-object OpenAPI 3.0.1 Request Body Object - required } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body Object - required } |", - "examples": [ - true - ], + "examples": [true], "default": false } }, - "required": [ - "content" - ], + "required": ["content"], "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#request-body-object OpenAPI 3.0.0 Request Body } |\n\n-----\nFields\n-----" }, @@ -4647,9 +4156,7 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } | | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static\nlinks to operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#response-object OpenAPI 3.0.0 Response } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#response-object OpenAPI 3.0.1 Response } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#response-object OpenAPI 3.0.2 Response } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#response-object OpenAPI 3.0.3 Response } |\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#response-object OpenAPI 3.0.4 Response } |\n\n-----\nFields\n-----" }, @@ -4669,10 +4176,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - operationId } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - operationId } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - operationId } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - operationId } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - operationId } |", - "examples": [ - "getUserById", - "createPet" - ] + "examples": ["getUserById", "createPet"] }, "parameters": { "type": "object", @@ -4702,10 +4206,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#link-object OpenAPI 3.0.4 Link Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#link-object OpenAPI 3.0.3 Link Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#link-object OpenAPI 3.0.2 Link Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#link-object OpenAPI 3.0.1 Link Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#link-object OpenAPI 3.0.0 Link Object - description } |", - "examples": [ - "Get user by ID", - "Create a new pet" - ] + "examples": ["Get user by ID", "Create a new pet"] }, "server": { "$ref": "#/definitions/Server", @@ -4984,71 +4485,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - type } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - type } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - type } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - type } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth 2.0 authentication" - ] + "examples": ["API key authentication", "OAuth 2.0 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - in } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - in } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - in } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - in } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - scheme } |", - "examples": [ - "bearer", - "basic" - ] + "examples": ["bearer", "basic"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - bearerFormat } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - bearerFormat } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - bearerFormat } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - bearerFormat } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -5067,14 +4538,10 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme Object - openIdConnectUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme Object - openIdConnectUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme Object - openIdConnectUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme Object - openIdConnectUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header or as a query parameter), OAuth2's common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations. It supports various authentication methods including HTTP authentication, API keys, OAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations.\nSupported schemes are HTTP authentication, an API key (either as a header or as a query parameter),\nOAuth2's common flows (implicit, password, application and access code) as defined in RFC6749,\nand OpenID Connect Discovery.\n\nThe Security Scheme Object defines a security scheme that can be used by the operations.\nIt supports various authentication methods including HTTP authentication, API keys,\nOAuth2 flows, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#security-scheme-object OpenAPI 3.0.4 Security Scheme } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#security-scheme-object OpenAPI 3.0.3 Security Scheme } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#security-scheme-object OpenAPI 3.0.2 Security Scheme } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#security-scheme-object OpenAPI 3.0.1 Security Scheme } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#security-scheme-object OpenAPI 3.0.0 Security Scheme } |\n\n-----\nFields\n-----" }, @@ -5154,19 +4621,13 @@ "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - tokenUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - tokenUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - tokenUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - tokenUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - tokenUrl } |", - "examples": [ - "https://example.com/oauth/token", - "https://api.example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token", "https://api.example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow Object - refreshUrl } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow Object - refreshUrl } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow Object - refreshUrl } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow Object - refreshUrl } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow Object - refreshUrl } |", - "examples": [ - "https://example.com/oauth/refresh", - "https://api.example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh", "https://api.example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -5186,9 +4647,7 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow. Different OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\nThe OAuth Flow Object contains configuration details for a specific OAuth flow.\nDifferent OAuth flows require different combinations of URLs and parameters.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#oauth-flow-object OpenAPI 3.0.4 OAuth Flow } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#oauth-flow-object OpenAPI 3.0.3 OAuth Flow } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#oauth-flow-object OpenAPI 3.0.2 OAuth Flow } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#oauth-flow-object OpenAPI 3.0.1 OAuth Flow } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#oauth-flow-object OpenAPI 3.0.0 OAuth Flow } |\n\n-----\nFields\n-----" }, @@ -5199,20 +4658,13 @@ "type": "string", "description": "The name of the tag. This field is required.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", "markdownDescription": "The name of the tag. This field is required.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - name } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - name } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - name } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - name } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - name } |", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n* | Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.\n*\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag Object - description } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag Object - description } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag Object - description } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag Object - description } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag Object - description } |", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -5226,11 +4678,9 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } | | 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } | | 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } | | 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } | | 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.0.4 | {@link https://spec.openapis.org/oas/v3.0.4#tag-object OpenAPI 3.0.4 Tag } |\n| 3.0.3 | {@link https://spec.openapis.org/oas/v3.0.3#tag-object OpenAPI 3.0.3 Tag } |\n| 3.0.2 | {@link https://spec.openapis.org/oas/v3.0.2#tag-object OpenAPI 3.0.2 Tag } |\n| 3.0.1 | {@link https://spec.openapis.org/oas/v3.0.1#tag-object OpenAPI 3.0.1 Tag } |\n| 3.0.0 | {@link https://spec.openapis.org/oas/v3.0.0#tag-object OpenAPI 3.0.0 Tag } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/callback.json b/schemas/3.1/components/callback.json index 5bf6b7c..2aeb2d4 100644 --- a/schemas/3.1/components/callback.json +++ b/schemas/3.1/components/callback.json @@ -28,10 +28,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -48,9 +45,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -165,18 +160,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -188,10 +176,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -215,10 +200,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -246,24 +228,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -275,38 +247,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -318,21 +277,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -344,17 +295,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -376,10 +321,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -400,17 +342,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -426,48 +362,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -494,19 +410,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -594,11 +504,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -614,24 +520,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -657,10 +554,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -759,10 +653,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -775,10 +666,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -799,17 +687,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -821,32 +703,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -858,64 +728,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -935,19 +779,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1019,18 +857,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1082,17 +913,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1183,17 +1008,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1205,57 +1024,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1346,17 +1145,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1447,17 +1240,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1518,17 +1305,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1628,17 +1409,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1765,17 +1540,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1788,33 +1557,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1823,11 +1584,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1836,32 +1593,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1946,11 +1691,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1962,10 +1703,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2001,11 +1739,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2036,15 +1770,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2128,11 +1857,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2144,11 +1869,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2179,40 +1900,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2224,64 +1930,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2300,10 +1985,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2349,11 +2031,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2365,10 +2043,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2404,23 +2079,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2874,17 +2540,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -2905,10 +2565,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -2940,10 +2597,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -2959,11 +2613,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -2999,13 +2649,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3023,11 +2667,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3298,11 +2938,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3312,22 +2948,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3342,45 +2966,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3399,22 +3004,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3479,11 +3076,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3495,25 +3088,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3530,17 +3117,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3552,20 +3133,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3579,20 +3153,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/example.json b/schemas/3.1/components/example.json index d37fba2..ec03af9 100644 --- a/schemas/3.1/components/example.json +++ b/schemas/3.1/components/example.json @@ -6,10 +6,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -45,11 +42,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----", @@ -61,10 +54,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -81,9 +71,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -198,18 +186,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -221,10 +202,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -248,10 +226,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -279,24 +254,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -308,38 +273,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -351,21 +303,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -377,17 +321,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -409,10 +347,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -433,17 +368,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -459,48 +388,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -527,19 +436,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -627,11 +530,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -647,24 +546,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -690,10 +580,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -792,10 +679,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -808,10 +692,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -832,17 +713,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -854,32 +729,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -891,64 +754,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -968,19 +805,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1052,18 +883,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1115,17 +939,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1216,17 +1034,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1238,57 +1050,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1379,17 +1171,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1480,17 +1266,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1551,17 +1331,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1661,17 +1435,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1798,17 +1566,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1821,33 +1583,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1856,11 +1610,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1869,32 +1619,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1979,11 +1717,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1995,10 +1729,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2034,11 +1765,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2069,15 +1796,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2161,11 +1883,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2177,11 +1895,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2212,40 +1926,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2257,64 +1956,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2333,10 +2011,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2382,11 +2057,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2398,10 +2069,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2437,23 +2105,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2907,17 +2566,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -2938,10 +2591,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -2973,10 +2623,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -2992,11 +2639,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3032,13 +2675,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3056,11 +2693,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3331,11 +2964,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3345,22 +2974,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3375,45 +2992,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3432,22 +3030,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3512,11 +3102,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3528,25 +3114,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3563,17 +3143,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3585,20 +3159,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3612,20 +3179,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/header.json b/schemas/3.1/components/header.json index aa63328..c0f2969 100644 --- a/schemas/3.1/components/header.json +++ b/schemas/3.1/components/header.json @@ -6,64 +6,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -82,10 +61,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -131,11 +107,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----", @@ -147,10 +119,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -167,9 +136,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -284,18 +251,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -307,10 +267,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -334,10 +291,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -365,24 +319,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -394,38 +338,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -437,21 +368,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -463,17 +386,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -495,10 +412,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -519,17 +433,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -545,48 +453,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -613,19 +501,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -713,11 +595,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -733,24 +611,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -776,10 +645,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -878,10 +744,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -894,10 +757,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -918,17 +778,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -940,32 +794,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -977,64 +819,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -1054,19 +870,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1138,18 +948,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1201,17 +1004,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1302,17 +1099,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1324,57 +1115,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1465,17 +1236,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1566,17 +1331,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1637,17 +1396,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1747,17 +1500,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1884,17 +1631,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1907,33 +1648,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1942,11 +1675,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1955,32 +1684,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2065,11 +1782,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2081,10 +1794,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2120,11 +1830,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2155,15 +1861,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2247,11 +1948,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2263,11 +1960,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2298,40 +1991,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2343,64 +2021,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2419,10 +2076,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2468,11 +2122,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2484,10 +2134,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2523,23 +2170,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2993,17 +2631,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -3024,10 +2656,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -3059,10 +2688,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -3078,11 +2704,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3118,13 +2740,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3142,11 +2758,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3417,11 +3029,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3431,22 +3039,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3461,45 +3057,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3518,22 +3095,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3598,11 +3167,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3614,25 +3179,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3649,17 +3208,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3671,20 +3224,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3698,20 +3244,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/link.json b/schemas/3.1/components/link.json index 18fc8d5..1c81729 100644 --- a/schemas/3.1/components/link.json +++ b/schemas/3.1/components/link.json @@ -15,10 +15,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -50,10 +47,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -69,11 +63,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----", @@ -85,10 +75,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -105,9 +92,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -222,18 +207,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -245,10 +223,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -272,10 +247,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -303,24 +275,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -332,38 +294,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -375,21 +324,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -401,17 +342,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -433,10 +368,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -457,17 +389,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -483,48 +409,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -551,19 +457,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -651,11 +551,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -671,24 +567,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -714,10 +601,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -816,10 +700,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -832,10 +713,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -856,17 +734,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -878,32 +750,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -915,64 +775,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -992,19 +826,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1076,18 +904,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1139,17 +960,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1240,17 +1055,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1262,57 +1071,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1403,17 +1192,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1504,17 +1287,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1575,17 +1352,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1685,17 +1456,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1822,17 +1587,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1845,33 +1604,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1880,11 +1631,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1893,32 +1640,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2003,11 +1738,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2019,10 +1750,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2058,11 +1786,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2093,15 +1817,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2185,11 +1904,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2201,11 +1916,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2236,40 +1947,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2281,64 +1977,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2357,10 +2032,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2406,11 +2078,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2422,10 +2090,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2461,23 +2126,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2931,17 +2587,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -2962,10 +2612,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -2997,10 +2644,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -3016,11 +2660,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3056,13 +2696,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3080,11 +2714,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3355,11 +2985,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3369,22 +2995,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3399,45 +3013,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3456,22 +3051,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3536,11 +3123,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3552,25 +3135,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3587,17 +3164,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3609,20 +3180,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3636,20 +3200,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/parameter.json b/schemas/3.1/components/parameter.json index a573365..c43a6bd 100644 --- a/schemas/3.1/components/parameter.json +++ b/schemas/3.1/components/parameter.json @@ -6,64 +6,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -83,19 +57,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -167,18 +135,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----", @@ -190,10 +151,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -210,9 +168,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -327,18 +283,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -350,10 +299,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -377,10 +323,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -408,24 +351,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -437,38 +370,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -480,21 +400,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -506,17 +418,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -538,10 +444,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -562,17 +465,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -588,48 +485,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -656,19 +533,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -756,11 +627,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -776,24 +643,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -819,10 +677,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -921,10 +776,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -937,10 +789,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -961,17 +810,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -983,32 +826,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -1020,64 +851,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -1097,19 +902,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1181,18 +980,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1244,17 +1036,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1345,17 +1131,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1367,57 +1147,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1508,17 +1268,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1609,17 +1363,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1680,17 +1428,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1790,17 +1532,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1927,17 +1663,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1950,33 +1680,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1985,11 +1707,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1998,32 +1716,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2108,11 +1814,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2124,10 +1826,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2163,11 +1862,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2198,15 +1893,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2290,11 +1980,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2306,11 +1992,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2341,40 +2023,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2386,64 +2053,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2462,10 +2108,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2511,11 +2154,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2527,10 +2166,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2566,23 +2202,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -3036,17 +2663,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -3067,10 +2688,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -3102,10 +2720,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -3121,11 +2736,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3161,13 +2772,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3185,11 +2790,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3460,11 +3061,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3474,22 +3071,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3504,45 +3089,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3561,22 +3127,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3641,11 +3199,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3657,25 +3211,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3692,17 +3240,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3714,20 +3256,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3741,20 +3276,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/pathitem.json b/schemas/3.1/components/pathitem.json index 9461ba0..61b150c 100644 --- a/schemas/3.1/components/pathitem.json +++ b/schemas/3.1/components/pathitem.json @@ -6,19 +6,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -106,11 +100,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----", @@ -122,10 +112,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -142,9 +129,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -259,18 +244,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -282,10 +260,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -309,10 +284,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -340,24 +312,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -369,38 +331,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -412,21 +361,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -438,17 +379,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -470,10 +405,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -494,17 +426,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -520,48 +446,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -588,19 +494,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -688,11 +588,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -708,24 +604,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -751,10 +638,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -853,10 +737,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -869,10 +750,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -893,17 +771,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -915,32 +787,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -952,64 +812,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -1029,19 +863,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1113,18 +941,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1176,17 +997,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1277,17 +1092,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1299,57 +1108,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1440,17 +1229,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1541,17 +1324,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1612,17 +1389,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1722,17 +1493,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1859,17 +1624,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1882,33 +1641,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1917,11 +1668,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1930,32 +1677,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2040,11 +1775,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2056,10 +1787,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2095,11 +1823,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2130,15 +1854,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2222,11 +1941,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2238,11 +1953,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2273,40 +1984,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2318,64 +2014,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2394,10 +2069,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2443,11 +2115,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2459,10 +2127,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2498,23 +2163,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2968,17 +2624,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -2999,10 +2649,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -3034,10 +2681,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -3053,11 +2697,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3093,13 +2733,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3117,11 +2751,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3392,11 +3022,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3406,22 +3032,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3436,45 +3050,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3493,22 +3088,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3573,11 +3160,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3589,25 +3172,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3624,17 +3201,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3646,20 +3217,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3673,20 +3237,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/requestbody.json b/schemas/3.1/components/requestbody.json index ad8829c..ebc85e9 100644 --- a/schemas/3.1/components/requestbody.json +++ b/schemas/3.1/components/requestbody.json @@ -6,10 +6,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -45,23 +42,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----", @@ -73,10 +61,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -93,9 +78,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -210,18 +193,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -233,10 +209,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -260,10 +233,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -291,24 +261,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -320,38 +280,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -363,21 +310,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -389,17 +328,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -421,10 +354,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -445,17 +375,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -471,48 +395,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -539,19 +443,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -639,11 +537,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -659,24 +553,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -702,10 +587,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -804,10 +686,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -820,10 +699,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -844,17 +720,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -866,32 +736,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -903,64 +761,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -980,19 +812,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1064,18 +890,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1127,17 +946,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1228,17 +1041,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1250,57 +1057,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1391,17 +1178,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1492,17 +1273,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1563,17 +1338,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1673,17 +1442,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1810,17 +1573,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1833,33 +1590,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1868,11 +1617,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1881,32 +1626,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1991,11 +1724,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2007,10 +1736,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2046,11 +1772,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2081,15 +1803,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2173,11 +1890,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2189,11 +1902,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2224,40 +1933,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2269,64 +1963,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2345,10 +2018,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2394,11 +2064,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2410,10 +2076,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2449,23 +2112,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2919,17 +2573,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -2950,10 +2598,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -2985,10 +2630,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -3004,11 +2646,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3044,13 +2682,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3068,11 +2700,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3343,11 +2971,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3357,22 +2981,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3387,45 +2999,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3444,22 +3037,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3524,11 +3109,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3540,25 +3121,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3575,17 +3150,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3597,20 +3166,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3624,20 +3186,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/response.json b/schemas/3.1/components/response.json index 63beee5..2de2216 100644 --- a/schemas/3.1/components/response.json +++ b/schemas/3.1/components/response.json @@ -90,17 +90,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----", @@ -112,10 +106,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -132,9 +123,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -249,18 +238,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -272,10 +254,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -299,10 +278,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -330,24 +306,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -359,38 +325,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -402,21 +355,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -428,17 +373,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -460,10 +399,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -484,17 +420,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -510,48 +440,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -578,19 +488,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -678,11 +582,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -698,24 +598,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -741,10 +632,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -843,10 +731,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -859,10 +744,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -883,17 +765,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -905,32 +781,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -942,64 +806,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -1019,19 +857,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1103,18 +935,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1166,17 +991,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1267,17 +1086,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1289,57 +1102,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1430,17 +1223,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1531,17 +1318,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1602,17 +1383,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1712,17 +1487,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1849,17 +1618,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1872,33 +1635,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1907,11 +1662,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1920,32 +1671,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2030,11 +1769,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2046,10 +1781,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2085,11 +1817,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2120,15 +1848,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2212,11 +1935,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2228,11 +1947,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2263,40 +1978,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2308,64 +2008,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2384,10 +2063,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2433,11 +2109,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2449,10 +2121,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2488,23 +2157,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2958,17 +2618,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -2989,10 +2643,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -3024,10 +2675,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -3043,11 +2691,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3083,13 +2727,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3107,11 +2745,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3382,11 +3016,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3396,22 +3026,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3426,45 +3044,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3483,22 +3082,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3563,11 +3154,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3579,25 +3166,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3614,17 +3195,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3636,20 +3211,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3663,20 +3231,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/schema.json b/schemas/3.1/components/schema.json index ebc3c42..ff23aba 100644 --- a/schemas/3.1/components/schema.json +++ b/schemas/3.1/components/schema.json @@ -39,10 +39,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -59,9 +56,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -176,18 +171,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -199,10 +187,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -226,10 +211,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -257,24 +239,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -286,38 +258,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -329,21 +288,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -355,17 +306,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -387,10 +332,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -411,17 +353,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -437,48 +373,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -505,19 +421,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -605,11 +515,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -625,24 +531,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -668,10 +565,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -770,10 +664,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -786,10 +677,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -810,17 +698,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -832,32 +714,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -869,64 +739,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -946,19 +790,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1030,18 +868,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1093,17 +924,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1194,17 +1019,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1216,57 +1035,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1357,17 +1156,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1458,17 +1251,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1529,17 +1316,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1639,17 +1420,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1776,17 +1551,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1799,33 +1568,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1834,11 +1595,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1847,32 +1604,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1957,11 +1702,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1973,10 +1714,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2012,11 +1750,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2047,15 +1781,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2139,11 +1868,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2155,11 +1880,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2190,40 +1911,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2235,64 +1941,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2311,10 +1996,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2360,11 +2042,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2376,10 +2054,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2415,23 +2090,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2885,17 +2551,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -2916,10 +2576,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -2951,10 +2608,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -2970,11 +2624,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3010,13 +2660,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3034,11 +2678,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3309,11 +2949,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3323,22 +2959,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3353,45 +2977,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3410,22 +3015,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3490,11 +3087,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3506,25 +3099,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3541,17 +3128,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3563,20 +3144,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3590,20 +3164,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/components/securityscheme.json b/schemas/3.1/components/securityscheme.json index 1153dd9..e73fc32 100644 --- a/schemas/3.1/components/securityscheme.json +++ b/schemas/3.1/components/securityscheme.json @@ -4,75 +4,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "API key authentication", - "OAuth2 authentication with authorization code flow" - ] + "examples": ["API key authentication", "OAuth2 authentication with authorization code flow"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -91,22 +57,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----", @@ -118,10 +76,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -138,9 +93,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -255,18 +208,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -278,10 +224,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -305,10 +248,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -336,24 +276,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -365,38 +295,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -408,21 +325,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -434,17 +343,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -466,10 +369,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -490,17 +390,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -516,48 +410,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -584,19 +458,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -684,11 +552,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -704,24 +568,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -747,10 +602,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -849,10 +701,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -865,10 +714,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -889,17 +735,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -911,32 +751,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -948,64 +776,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -1025,19 +827,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1109,18 +905,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1172,17 +961,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1273,17 +1056,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1295,57 +1072,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1436,17 +1193,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1537,17 +1288,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1608,17 +1353,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1718,17 +1457,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1855,17 +1588,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1878,33 +1605,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1913,11 +1632,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1926,32 +1641,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2036,11 +1739,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2052,10 +1751,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2091,11 +1787,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2126,15 +1818,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2218,11 +1905,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2234,11 +1917,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2269,40 +1948,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2314,64 +1978,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2390,10 +2033,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2439,11 +2079,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2455,10 +2091,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2494,23 +2127,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2964,17 +2588,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -2995,10 +2613,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -3030,10 +2645,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -3049,11 +2661,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3089,13 +2697,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3113,11 +2715,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3388,11 +2986,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3402,22 +2996,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3432,45 +3014,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3489,22 +3052,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3569,11 +3124,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3585,25 +3136,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3620,17 +3165,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3642,20 +3181,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3669,20 +3201,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.1/index.ts b/schemas/3.1/index.ts index 65702f2..4174584 100644 --- a/schemas/3.1/index.ts +++ b/schemas/3.1/index.ts @@ -46,4 +46,3 @@ export const schemas = { callback, pathitem, } as const; - diff --git a/schemas/3.1/main/specification.json b/schemas/3.1/main/specification.json index 916fdd6..811d6c6 100644 --- a/schemas/3.1/main/specification.json +++ b/schemas/3.1/main/specification.json @@ -6,10 +6,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -26,9 +23,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -143,18 +138,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----", @@ -166,10 +154,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.", - "examples": [ - "3.1.0", - "3.1.1" - ] + "examples": ["3.1.0", "3.1.1"] }, "info": { "$ref": "#/definitions/Info", @@ -186,9 +171,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -303,18 +286,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#openapi-object OpenAPI 3.1.1 OpenAPI Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#openapi-object OpenAPI 3.1.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -326,10 +302,7 @@ "type": "string", "description": "The title of the API. This field is required.", "markdownDescription": "The title of the API. This field is required.", - "examples": [ - "Pet Store API", - "User Management API" - ] + "examples": ["Pet Store API", "User Management API"] }, "summary": { "type": "string", @@ -353,10 +326,7 @@ "type": "string", "description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", "markdownDescription": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", - "examples": [ - "http://example.com/terms/", - "https://www.example.com/terms-of-service" - ] + "examples": ["http://example.com/terms/", "https://www.example.com/terms-of-service"] }, "contact": { "$ref": "#/definitions/Contact", @@ -384,24 +354,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required.", "markdownDescription": "The version of the OpenAPI document. This field is required.", - "examples": [ - "1.0.0", - "2.1.3" - ] + "examples": ["1.0.0", "2.1.3"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#info-object OpenAPI 3.1.1 Info Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#info-object OpenAPI 3.1.0 Info Object } |\n\n-----\nFields\n-----" @@ -413,38 +373,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.", "markdownDescription": "The identifying name of the contact person/organization.", - "examples": [ - "API Support", - "Development Team" - ] + "examples": ["API Support", "Development Team"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.", "markdownDescription": "The URL pointing to the contact information. MUST be in the format of a URL.", - "examples": [ - "http://www.example.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.example.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.", "markdownDescription": "The email address of the contact person/organization. MUST be in the format of an email address.", - "examples": [ - "support@example.com", - "dev@example.com" - ] + "examples": ["support@example.com", "dev@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nContact information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#contact-object OpenAPI 3.1.1 Contact Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#contact-object OpenAPI 3.1.0 Contact Object } |\n\n-----\nFields\n-----" @@ -456,21 +403,13 @@ "type": "string", "description": "The license name used for the API. This field is required.", "markdownDescription": "The license name used for the API. This field is required.", - "examples": [ - "Apache 2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache 2.0", "MIT", "GPL-3.0"] }, "identifier": { "type": "string", "description": "An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.", "markdownDescription": "An SPDX license expression for the API. The `identifier` field is mutually\nexclusive of the `url` field.", - "examples": [ - "Apache-2.0", - "MIT", - "GPL-3.0" - ] + "examples": ["Apache-2.0", "MIT", "GPL-3.0"] }, "url": { "type": "string", @@ -482,17 +421,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nLicense information for the exposed API.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#license-object OpenAPI 3.1.1 License Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#license-object OpenAPI 3.1.0 License Object } |\n\n-----\nFields\n-----" @@ -514,10 +447,7 @@ "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional string describing the host designated by the URL. CommonMark syntax\nMAY be used for rich text representation.", - "examples": [ - "The production API server", - "The staging API server" - ] + "examples": ["The production API server", "The staging API server"] }, "variables": { "type": "object", @@ -538,17 +468,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-object OpenAPI 3.1.1 Server Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-object OpenAPI 3.1.0 Server Object } |\n\n-----\nFields\n-----" @@ -564,48 +488,28 @@ "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.", "markdownDescription": "An enumeration of string values to be used if the substitution options are\nfrom a limited set. The array SHOULD NOT be empty.", "examples": [ - [ - "8443", - "443" - ], - [ - "v1", - "v2", - "v3" - ] + ["8443", "443"], + ["v1", "v2", "v3"] ] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value SHOULD exist in the enum's values.", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an alternate\nvalue is not supplied. Note this behavior is different than the Schema Object's\ntreatment of default values, because in those cases parameter values are optional.\nIf the enum is defined, the value SHOULD exist in the enum's values.", - "examples": [ - "demo", - "8443", - "v1" - ] + "examples": ["demo", "8443", "v1"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional description for the server variable. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "this value is assigned by the service provider", - "The port number" - ] + "examples": ["this value is assigned by the service provider", "The port number"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#server-variable-object OpenAPI 3.1.1 Server Variable Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#server-variable-object OpenAPI 3.1.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -632,19 +536,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -732,11 +630,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#path-item-object OpenAPI 3.1.1 Path Item Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#path-item-object OpenAPI 3.1.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -752,24 +646,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical\ngrouping of operations by resources or any other qualifier.", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.", "markdownDescription": "A short summary of what the operation does.", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -795,10 +680,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive.", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all\noperations described in the API. The operationId value is case-sensitive.", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -897,10 +779,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from using the declared operation. Default value is false.", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from using\nthe declared operation. Default value is false.", - "examples": [ - true, - false - ], + "examples": [true, false], "default": false }, "security": { @@ -913,10 +792,7 @@ "examples": [ [ { - "petstore_auth": [ - "write:pets", - "read:pets" - ] + "petstore_auth": ["write:pets", "read:pets"] } ] ] @@ -937,17 +813,11 @@ ] } }, - "required": [ - "responses" - ], + "required": ["responses"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#operation-object OpenAPI 3.1.1 Operation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#operation-object OpenAPI 3.1.0 Operation Object } |\n\n-----\nFields\n-----" @@ -959,32 +829,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#external-documentation-object OpenAPI 3.1.1 External Documentation Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#external-documentation-object OpenAPI 3.1.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -996,64 +854,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.", - "examples": [ - "userId", - "limit", - "X-API-Key" - ] + "examples": ["userId", "limit", "X-API-Key"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "The user ID to retrieve", - "Maximum number of items to return" - ] + "examples": ["The user ID to retrieve", "Maximum number of items to return"] }, "required": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -1073,19 +905,13 @@ "type": "boolean", "description": "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.", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1157,18 +983,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location. The parameter name is case sensitive.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination\nof a name and location. The parameter name is case sensitive.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#parameter-object OpenAPI 3.1.1 Parameter Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#parameter-object OpenAPI 3.1.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1220,17 +1039,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.1.x rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1321,17 +1134,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userName\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1343,57 +1150,37 @@ "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nWhen defined within the Items Object (items), it will affect the name of the individual\nXML elements within the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element and only if wrapped is true. If wrapped is false,\nit will be ignored.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name.", "markdownDescription": "The prefix to be used for the name.", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] }, "attribute": { "type": "boolean", "description": "Declares whether the property definition translates to an attribute instead of an element. Default value is false.", "markdownDescription": "Declares whether the property definition translates to an attribute instead of an element.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "wrapped": { "type": "boolean", "description": "MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ``) or unwrapped (for example, ``). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).", "markdownDescription": "MAY be used only for an array definition. Signifies whether the array is wrapped\n(for example, ``) or unwrapped\n(for example, ``). Default value is false. The definition takes effect\nonly when defined alongside type being array (outside the items).", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#xml-object OpenAPI 3.1.1 XML Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#xml-object OpenAPI 3.1.0 XML Object } |\n\n-----\nFields\n-----" @@ -1484,17 +1271,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"price\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1585,17 +1366,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"userId\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1656,17 +1431,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"isActive\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1766,17 +1535,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"users\", wrapped: true }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1903,17 +1666,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions.\n\nExample: `{ name: \"user\", attribute: false }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#data-types OpenAPI 3.1.1 Data Types } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#data-types OpenAPI 3.1.0 Data Types } |\n\n-----\nFields\n-----" @@ -1926,33 +1683,25 @@ "const": "null", "description": "The type identifier for null schemas. This field is required.", "markdownDescription": "The type identifier for null schemas. This field is required.", - "examples": [ - "null" - ] + "examples": ["null"] }, "title": { "type": "string", "description": "A short title for the schema.", "markdownDescription": "A short title for the schema.", - "examples": [ - "Null Value" - ] + "examples": ["Null Value"] }, "description": { "type": "string", "description": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the schema. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Represents a null value" - ] + "examples": ["Represents a null value"] }, "default": { "type": "null", "description": "The default value for the schema.", "markdownDescription": "The default value for the schema.", - "examples": [ - null - ] + "examples": [null] }, "examples": { "type": "array", @@ -1961,11 +1710,7 @@ }, "description": "An array of example values.", "markdownDescription": "An array of example values.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "enum": { "type": "array", @@ -1974,32 +1719,20 @@ }, "description": "An enumeration of allowed values. For null schemas, this should contain only null.", "markdownDescription": "An enumeration of allowed values. For null schemas, this should contain only null.", - "examples": [ - [ - null - ] - ] + "examples": [[null]] }, "const": { "type": "null", "description": "A constant allowed value. For null schemas, this should be null.", "markdownDescription": "A constant allowed value. For null schemas, this should be null.", - "examples": [ - null - ] + "examples": [null] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Null Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema specification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNull Schema\n-----\n\nA schema that represents the null value type. This is part of the JSON Schema\nspecification and is supported in OpenAPI 3.1.x.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2084,11 +1817,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#schema-object OpenAPI 3.1.1 Schema Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#schema-object OpenAPI 3.1.0 Schema Object } |\n\n-----\nFields\n-----" @@ -2100,10 +1829,7 @@ "type": "string", "description": "Short description for the example.", "markdownDescription": "Short description for the example.", - "examples": [ - "A user example", - "Error response example" - ] + "examples": ["A user example", "Error response example"] }, "description": { "type": "string", @@ -2139,11 +1865,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema\nof its associated value. Tooling implementations MAY choose to validate compatibility\nautomatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#example-object OpenAPI 3.1.1 Example Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#example-object OpenAPI 3.1.0 Example Object } |\n\n-----\nFields\n-----" @@ -2174,15 +1896,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#reference-object OpenAPI 3.1.1 Reference Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#reference-object OpenAPI 3.1.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2266,11 +1983,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key. Media Type Objects can be used in a Content Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\nMedia Type Objects can be used in a Content Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#media-type-object OpenAPI 3.1.1 Media Type Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#media-type-object OpenAPI 3.1.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2282,11 +1995,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is determined based on the inner type.", "markdownDescription": "The Content-Type for encoding a specific property. Default value depends on the\nproperty type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json;\nfor array – the default is determined based on the inner type.", - "examples": [ - "image/png", - "application/json", - "text/plain" - ] + "examples": ["image/png", "application/json", "text/plain"] }, "headers": { "type": "object", @@ -2317,40 +2026,25 @@ "type": "string", "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the\nsame values as query parameters, including default values. This property SHALL be\nignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded or multipart/form-data.", "markdownDescription": "When this is true, property values of type array or object generate separate\nparameters for each value of the array or key-value pair of the map. For other\ntypes of properties this property has no effect. When style is form, the default\nvalue is true. For all other styles, the default value is false. This property\nSHALL be ignored if the request body media type is not application/x-www-form-urlencoded\nor multipart/form-data.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined\nby RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default\nvalue is false. This property SHALL be ignored if the request body media type is\nnot application/x-www-form-urlencoded.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#encoding-object OpenAPI 3.1.1 Encoding Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#encoding-object OpenAPI 3.1.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2362,64 +2056,43 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Rate limit per hour", - "Custom authentication token" - ] + "examples": ["Rate limit per hour", "Custom authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. The property MAY be included and its default value is false.", "markdownDescription": "Determines whether this header is mandatory. The property MAY be included and its\ndefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage. Default value is false.", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\nDefault value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. This is valid only for headers and allows sending a header with an empty value. Default value is false.", "markdownDescription": "Sets the ability to pass empty-valued headers. This is valid only for headers\nand allows sending a header with an empty value. Default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "description": "Describes how the header value will be serialized. The default value is \"simple\".", "markdownDescription": "Describes how the header value will be serialized. The default value is \"simple\".", - "examples": [ - "simple", - "form" - ] + "examples": ["simple", "form"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. When style is form, the default value is true. For all other\nstyles, the default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2438,10 +2111,7 @@ "example": { "description": "Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field.", "markdownDescription": "Example of the header's potential value. The example SHOULD match the specified\nschema and encoding properties if present. The example field is mutually exclusive\nof the examples field.", - "examples": [ - "example value", - 42 - ] + "examples": ["example value", 42] }, "examples": { "type": "object", @@ -2487,11 +2157,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding headers map. 2. `in` MUST NOT be specified, it is implicitly in header. 3. All traits that are affected by the location MUST be applicable to a location of header (for example, style).\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding headers map.\n2. `in` MUST NOT be specified, it is implicitly in header.\n3. All traits that are affected by the location MUST be applicable to a location of header\n (for example, style).\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#header-object OpenAPI 3.1.1 Header Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#header-object OpenAPI 3.1.0 Header Object } |\n\n-----\nFields\n-----" @@ -2503,10 +2169,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User data to create", - "File upload with metadata" - ] + "examples": ["User data to create", "File upload with metadata"] }, "content": { "type": "object", @@ -2542,23 +2205,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request. The request body is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body. A request body is the payload sent with an HTTP request.\nThe request body is only supported in HTTP methods where the HTTP 1.1 specification\nRFC7231 has explicitly defined semantics for request bodies.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#request-body-object OpenAPI 3.1.1 Request Body Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#request-body-object OpenAPI 3.1.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -3012,17 +2666,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links to operations based on the response.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation, including design-time, static links\nto operations based on the response.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#response-object OpenAPI 3.1.1 Response Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#response-object OpenAPI 3.1.0 Response Object } |\n\n-----\nFields\n-----" @@ -3043,10 +2691,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.", "markdownDescription": "The name of an existing, resolvable OAS operation, as defined with a unique operationId.\nThis field is mutually exclusive of the operationRef field.", - "examples": [ - "getUserById", - "createUser" - ] + "examples": ["getUserById", "createUser"] }, "parameters": { "type": "object", @@ -3078,10 +2723,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "Get the user by ID", - "Create a new user with the provided data" - ] + "examples": ["Get the user by ID", "Create a new user with the provided data"] }, "server": { "$ref": "#/definitions/Server", @@ -3097,11 +2739,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link\ndoes not guarantee the caller's ability to successfully invoke it, rather it provides a known\nrelationship and traversal mechanism between responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#link-object OpenAPI 3.1.1 Link Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#link-object OpenAPI 3.1.0 Link Object } |\n\n-----\nFields\n-----" @@ -3137,13 +2775,7 @@ }, "description": "Each name MUST correspond to a security scheme which is declared in the Security Schemes under the Components Object. The value is an array of scope names required for the execution. For OAuth2, the scopes are the scopes required for the execution. For other security schemes, the array MUST be empty.", "markdownDescription": "Each name MUST correspond to a security scheme which is declared in the\nSecurity Schemes under the Components Object. The value is an array of\nscope names required for the execution. For OAuth2, the scopes are the\nscopes required for the execution. For other security schemes, the array\nMUST be empty.", - "examples": [ - [], - [ - "write:pets", - "read:pets" - ] - ] + "examples": [[], ["write:pets", "read:pets"]] }, "description": "----- Security Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Requirement Object\n-----\n\nLists the required security schemes for execution of the operation. The name\nused for each property MUST correspond to a security scheme declared in the\nSecurity Schemes under the Components Object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-requirement-object OpenAPI 3.1.1 Security Requirement Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-requirement-object OpenAPI 3.1.0 Security Requirement Object } |\n\n-----\nFields\n-----" @@ -3161,11 +2793,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3436,11 +3064,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#components-object OpenAPI 3.1.1 Components Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#components-object OpenAPI 3.1.0 Components Object } |\n\n-----\nFields\n-----" @@ -3450,22 +3074,10 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"], "description": "The type of the security scheme. This field is required.", "markdownDescription": "The type of the security scheme. This field is required.", - "examples": [ - "apiKey", - "http", - "mutualTLS", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "mutualTLS", "oauth2", "openIdConnect"] }, "description": { "type": "string", @@ -3480,45 +3092,26 @@ "type": "string", "description": "The name of the header, query or cookie parameter to be used. This field is required for `apiKey` type.", "markdownDescription": "The name of the header, query or cookie parameter to be used. This field\nis required for `apiKey` type.", - "examples": [ - "X-API-Key", - "api_key", - "sessionId" - ] + "examples": ["X-API-Key", "api_key", "sessionId"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. This field is required for `apiKey` type.", "markdownDescription": "The location of the API key. This field is required for `apiKey` type.", - "examples": [ - "header", - "query", - "cookie" - ] + "examples": ["header", "query", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header. This field is required for `http` type.", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization\nheader. This field is required for `http` type.", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "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.", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer\ntokens are usually generated by an authorization server, so this information\nis primarily for documentation purposes.", - "examples": [ - "JWT", - "Bearer" - ] + "examples": ["JWT", "Bearer"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3537,22 +3130,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. This field is required for `openIdConnect` type.", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be\nin the form of a URL. This field is required for `openIdConnect` type.", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes\nare HTTP authentication, an API key (either as a header, a cookie parameter or\nas a query parameter), mutual TLS (use of a client certificate), OAuth2's common\nflows (implicit, password, client credentials and authorization code) as defined\nin RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#security-scheme-object OpenAPI 3.1.1 Security Scheme Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#security-scheme-object OpenAPI 3.1.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3617,11 +3202,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flows-object OpenAPI 3.1.1 OAuth Flows Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flows-object OpenAPI 3.1.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3633,25 +3214,19 @@ "type": "string", "description": "The authorization URL to be used for this flow. This MUST be in the form of a URL. This field is required for `implicit` and `authorizationCode` flows.", "markdownDescription": "The authorization URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `implicit` and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/authorize" - ] + "examples": ["https://example.com/oauth/authorize"] }, "tokenUrl": { "type": "string", "description": "The token URL to be used for this flow. This MUST be in the form of a URL. This field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", "markdownDescription": "The token URL to be used for this flow. This MUST be in the form of a URL.\nThis field is required for `password`, `clientCredentials`, and `authorizationCode` flows.", - "examples": [ - "https://example.com/oauth/token" - ] + "examples": ["https://example.com/oauth/token"] }, "refreshUrl": { "type": "string", "description": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", "markdownDescription": "The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.", - "examples": [ - "https://example.com/oauth/refresh" - ] + "examples": ["https://example.com/oauth/refresh"] }, "scopes": { "type": "object", @@ -3668,17 +3243,11 @@ ] } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#oauth-flow-object OpenAPI 3.1.1 OAuth Flow Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#oauth-flow-object OpenAPI 3.1.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3690,20 +3259,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3717,20 +3279,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } | | 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.1.1 | {@link https://spec.openapis.org/oas/v3.1.1#tag-object OpenAPI 3.1.1 Tag Object } |\n| 3.1.0 | {@link https://spec.openapis.org/oas/v3.1.0#tag-object OpenAPI 3.1.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/callback.json b/schemas/3.2/components/callback.json index 1531d95..92e7a35 100644 --- a/schemas/3.2/components/callback.json +++ b/schemas/3.2/components/callback.json @@ -22,9 +22,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -41,9 +39,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -158,18 +154,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -181,33 +170,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -235,23 +216,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -263,38 +235,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -306,11 +265,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -323,17 +278,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -345,17 +294,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -376,17 +321,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -401,41 +340,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -462,19 +386,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -536,11 +454,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -556,24 +470,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -593,10 +498,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -635,10 +537,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -660,11 +559,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -676,32 +571,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -713,64 +596,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -799,19 +656,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -831,10 +682,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -877,18 +725,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -937,17 +778,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1023,17 +858,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1043,60 +872,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1182,17 +985,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1278,17 +1075,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1344,17 +1135,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1449,17 +1234,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1589,17 +1368,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1690,11 +1463,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1706,10 +1475,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1745,11 +1511,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1780,15 +1542,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1870,11 +1627,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1886,11 +1639,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -1918,48 +1667,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -1971,64 +1700,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2047,10 +1756,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2096,11 +1802,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2112,10 +1814,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2138,23 +1837,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2524,10 +2214,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2600,17 +2287,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2631,10 +2312,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2672,10 +2350,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2691,11 +2366,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2740,11 +2411,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -2991,11 +2658,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3005,72 +2668,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3091,22 +2723,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3143,11 +2767,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3184,17 +2804,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3206,20 +2820,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3233,20 +2840,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/example.json b/schemas/3.2/components/example.json index b09cc88..1bc3ee1 100644 --- a/schemas/3.2/components/example.json +++ b/schemas/3.2/components/example.json @@ -6,10 +6,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -45,11 +42,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----", @@ -61,9 +54,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -80,9 +71,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -197,18 +186,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -220,33 +202,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -274,23 +248,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -302,38 +267,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -345,11 +297,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -362,17 +310,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -384,17 +326,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -415,17 +353,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -440,41 +372,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -501,19 +418,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -575,11 +486,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -595,24 +502,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -632,10 +530,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -674,10 +569,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -699,11 +591,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -715,32 +603,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -752,64 +628,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -838,19 +688,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -870,10 +714,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -916,18 +757,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -976,17 +810,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1062,17 +890,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1082,60 +904,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1221,17 +1017,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1317,17 +1107,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1383,17 +1167,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1488,17 +1266,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1628,17 +1400,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1729,11 +1495,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1745,10 +1507,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1784,11 +1543,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1819,15 +1574,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1909,11 +1659,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1925,11 +1671,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -1957,48 +1699,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2010,64 +1732,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2086,10 +1788,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2135,11 +1834,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2151,10 +1846,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2177,23 +1869,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2563,10 +2246,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2639,17 +2319,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2670,10 +2344,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2711,10 +2382,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2730,11 +2398,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2779,11 +2443,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3030,11 +2690,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3044,72 +2700,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3130,22 +2755,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3182,11 +2799,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3223,17 +2836,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3245,20 +2852,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3272,20 +2872,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/header.json b/schemas/3.2/components/header.json index 61fa5d0..4a2232b 100644 --- a/schemas/3.2/components/header.json +++ b/schemas/3.2/components/header.json @@ -6,64 +6,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -82,10 +62,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -131,11 +108,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----", @@ -147,9 +120,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -166,9 +137,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -283,18 +252,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -306,33 +268,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -360,23 +314,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -388,38 +333,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -431,11 +363,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -448,17 +376,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -470,17 +392,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -501,17 +419,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -526,41 +438,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -587,19 +484,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -661,11 +552,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -681,24 +568,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -718,10 +596,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -760,10 +635,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -785,11 +657,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -801,32 +669,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -838,64 +694,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -924,19 +754,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -956,10 +780,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -1002,18 +823,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1062,17 +876,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1148,17 +956,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1168,60 +970,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1307,17 +1083,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1403,17 +1173,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1469,17 +1233,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1574,17 +1332,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1714,17 +1466,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1815,11 +1561,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1831,10 +1573,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1870,11 +1609,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1905,15 +1640,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1995,11 +1725,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2011,11 +1737,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -2043,48 +1765,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2096,64 +1798,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2172,10 +1854,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2221,11 +1900,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2237,10 +1912,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2263,23 +1935,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2649,10 +2312,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2725,17 +2385,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2756,10 +2410,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2797,10 +2448,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2816,11 +2464,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2865,11 +2509,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3116,11 +2756,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3130,72 +2766,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3216,22 +2821,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3268,11 +2865,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3309,17 +2902,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3331,20 +2918,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3358,20 +2938,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/link.json b/schemas/3.2/components/link.json index a5bddd6..e8c3f11 100644 --- a/schemas/3.2/components/link.json +++ b/schemas/3.2/components/link.json @@ -15,10 +15,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -56,10 +53,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -75,11 +69,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----", @@ -91,9 +81,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -110,9 +98,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -227,18 +213,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -250,33 +229,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -304,23 +275,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -332,38 +294,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -375,11 +324,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -392,17 +337,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -414,17 +353,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -445,17 +380,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -470,41 +399,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -531,19 +445,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -605,11 +513,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -625,24 +529,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -662,10 +557,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -704,10 +596,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -729,11 +618,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -745,32 +630,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -782,64 +655,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -868,19 +715,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -900,10 +741,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -946,18 +784,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1006,17 +837,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1092,17 +917,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1112,60 +931,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1251,17 +1044,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1347,17 +1134,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1413,17 +1194,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1518,17 +1293,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1658,17 +1427,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1759,11 +1522,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1775,10 +1534,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1814,11 +1570,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1849,15 +1601,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1939,11 +1686,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1955,11 +1698,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -1987,48 +1726,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2040,64 +1759,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2116,10 +1815,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2165,11 +1861,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2181,10 +1873,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2207,23 +1896,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2593,10 +2273,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2669,17 +2346,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2700,10 +2371,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2741,10 +2409,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2760,11 +2425,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2809,11 +2470,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3060,11 +2717,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3074,72 +2727,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3160,22 +2782,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3212,11 +2826,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3253,17 +2863,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3275,20 +2879,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3302,20 +2899,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/mediatype.json b/schemas/3.2/components/mediatype.json index 792b1a7..51f732c 100644 --- a/schemas/3.2/components/mediatype.json +++ b/schemas/3.2/components/mediatype.json @@ -76,11 +76,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----", @@ -92,9 +88,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -111,9 +105,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -228,18 +220,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -251,33 +236,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -305,23 +282,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -333,38 +301,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -376,11 +331,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -393,17 +344,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -415,17 +360,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -446,17 +387,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -471,41 +406,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -532,19 +452,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -606,11 +520,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -626,24 +536,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -663,10 +564,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -705,10 +603,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -730,11 +625,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -746,32 +637,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -783,64 +662,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -869,19 +722,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -901,10 +748,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -947,18 +791,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1007,17 +844,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1093,17 +924,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1113,60 +938,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1252,17 +1051,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1348,17 +1141,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1414,17 +1201,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1519,17 +1300,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1659,17 +1434,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1760,11 +1529,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1776,10 +1541,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1815,11 +1577,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1850,15 +1608,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1940,11 +1693,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1956,11 +1705,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -1988,48 +1733,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2041,64 +1766,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2117,10 +1822,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2166,11 +1868,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2182,10 +1880,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2208,23 +1903,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2594,10 +2280,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2670,17 +2353,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2701,10 +2378,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2742,10 +2416,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2761,11 +2432,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2810,11 +2477,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3061,11 +2724,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3075,72 +2734,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3161,22 +2789,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3213,11 +2833,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3254,17 +2870,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3276,20 +2886,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3303,20 +2906,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/parameter.json b/schemas/3.2/components/parameter.json index cecfaa8..1d918db 100644 --- a/schemas/3.2/components/parameter.json +++ b/schemas/3.2/components/parameter.json @@ -6,64 +6,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -92,19 +66,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -124,10 +92,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -170,18 +135,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----", @@ -193,9 +151,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -212,9 +168,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -329,18 +283,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -352,33 +299,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -406,23 +345,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -434,38 +364,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -477,11 +394,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -494,17 +407,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -516,17 +423,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -547,17 +450,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -572,41 +469,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -633,19 +515,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -707,11 +583,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -727,24 +599,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -764,10 +627,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -806,10 +666,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -831,11 +688,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -847,32 +700,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -884,64 +725,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -970,19 +785,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -1002,10 +811,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -1048,18 +854,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1108,17 +907,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1194,17 +987,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1214,60 +1001,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1353,17 +1114,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1449,17 +1204,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1515,17 +1264,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1620,17 +1363,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1760,17 +1497,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1861,11 +1592,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1877,10 +1604,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1916,11 +1640,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1951,15 +1671,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2041,11 +1756,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2057,11 +1768,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -2089,48 +1796,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2142,64 +1829,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2218,10 +1885,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2267,11 +1931,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2283,10 +1943,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2309,23 +1966,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2695,10 +2343,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2771,17 +2416,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2802,10 +2441,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2843,10 +2479,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2862,11 +2495,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2911,11 +2540,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3162,11 +2787,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3176,72 +2797,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3262,22 +2852,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3314,11 +2896,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3355,17 +2933,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3377,20 +2949,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3404,20 +2969,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/pathitem.json b/schemas/3.2/components/pathitem.json index c5c777f..1f01140 100644 --- a/schemas/3.2/components/pathitem.json +++ b/schemas/3.2/components/pathitem.json @@ -6,19 +6,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -80,11 +74,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----", @@ -96,9 +86,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -115,9 +103,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -232,18 +218,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -255,33 +234,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -309,23 +280,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -337,38 +299,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -380,11 +329,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -397,17 +342,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -419,17 +358,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -450,17 +385,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -475,41 +404,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -536,19 +450,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -610,11 +518,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -630,24 +534,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -667,10 +562,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -709,10 +601,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -734,11 +623,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -750,32 +635,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -787,64 +660,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -873,19 +720,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -905,10 +746,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -951,18 +789,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1011,17 +842,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1097,17 +922,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1117,60 +936,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1256,17 +1049,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1352,17 +1139,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1418,17 +1199,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1523,17 +1298,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1663,17 +1432,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1764,11 +1527,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1780,10 +1539,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1819,11 +1575,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1854,15 +1606,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1944,11 +1691,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1960,11 +1703,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -1992,48 +1731,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2045,64 +1764,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2121,10 +1820,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2170,11 +1866,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2186,10 +1878,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2212,23 +1901,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2598,10 +2278,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2674,17 +2351,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2705,10 +2376,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2746,10 +2414,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2765,11 +2430,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2814,11 +2475,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3065,11 +2722,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3079,72 +2732,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3165,22 +2787,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3217,11 +2831,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3258,17 +2868,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3280,20 +2884,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3307,20 +2904,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/requestbody.json b/schemas/3.2/components/requestbody.json index 9c5063a..9383d93 100644 --- a/schemas/3.2/components/requestbody.json +++ b/schemas/3.2/components/requestbody.json @@ -6,10 +6,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -32,23 +29,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----", @@ -60,9 +48,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -79,9 +65,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -196,18 +180,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -219,33 +196,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -273,23 +242,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -301,38 +261,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -344,11 +291,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -361,17 +304,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -383,17 +320,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -414,17 +347,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -439,41 +366,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -500,19 +412,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -574,11 +480,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -594,24 +496,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -631,10 +524,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -673,10 +563,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -698,11 +585,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -714,32 +597,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -751,64 +622,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -837,19 +682,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -869,10 +708,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -915,18 +751,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -975,17 +804,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1061,17 +884,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1081,60 +898,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1220,17 +1011,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1316,17 +1101,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1382,17 +1161,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1487,17 +1260,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1627,17 +1394,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1728,11 +1489,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1744,10 +1501,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1783,11 +1537,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1818,15 +1568,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1908,11 +1653,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1924,11 +1665,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -1956,48 +1693,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2009,64 +1726,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2085,10 +1782,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2134,11 +1828,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2150,10 +1840,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2176,23 +1863,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2562,10 +2240,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2638,17 +2313,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2669,10 +2338,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2710,10 +2376,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2729,11 +2392,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2778,11 +2437,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3029,11 +2684,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3043,72 +2694,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3129,22 +2749,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3181,11 +2793,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3222,17 +2830,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3244,20 +2846,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3271,20 +2866,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/response.json b/schemas/3.2/components/response.json index 868041d..3fba2bf 100644 --- a/schemas/3.2/components/response.json +++ b/schemas/3.2/components/response.json @@ -6,10 +6,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -82,17 +79,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----", @@ -104,9 +95,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -123,9 +112,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -240,18 +227,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -263,33 +243,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -317,23 +289,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -345,38 +308,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -388,11 +338,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -405,17 +351,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -427,17 +367,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -458,17 +394,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -483,41 +413,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -544,19 +459,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -618,11 +527,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -638,24 +543,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -675,10 +571,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -717,10 +610,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -742,11 +632,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -758,32 +644,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -795,64 +669,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -881,19 +729,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -913,10 +755,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -959,18 +798,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1019,17 +851,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1105,17 +931,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1125,60 +945,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1264,17 +1058,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1360,17 +1148,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1426,17 +1208,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1531,17 +1307,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1671,17 +1441,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1772,11 +1536,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1788,10 +1548,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1827,11 +1584,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1862,15 +1615,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1952,11 +1700,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1968,11 +1712,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -2000,48 +1740,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2053,64 +1773,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2129,10 +1829,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2178,11 +1875,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2194,10 +1887,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2220,23 +1910,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2606,10 +2287,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2682,17 +2360,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2713,10 +2385,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2754,10 +2423,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2773,11 +2439,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2822,11 +2484,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3073,11 +2731,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3087,72 +2741,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3173,22 +2796,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3225,11 +2840,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3266,17 +2877,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3288,20 +2893,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3315,20 +2913,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/schema.json b/schemas/3.2/components/schema.json index 7886427..4ee8bdc 100644 --- a/schemas/3.2/components/schema.json +++ b/schemas/3.2/components/schema.json @@ -36,9 +36,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -55,9 +53,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -172,18 +168,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -195,33 +184,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -249,23 +230,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -277,38 +249,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -320,11 +279,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -337,17 +292,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -359,17 +308,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -390,17 +335,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -415,41 +354,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -476,19 +400,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -550,11 +468,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -570,24 +484,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -607,10 +512,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -649,10 +551,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -674,11 +573,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -690,32 +585,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -727,64 +610,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -813,19 +670,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -845,10 +696,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -891,18 +739,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -951,17 +792,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1037,17 +872,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1057,60 +886,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1196,17 +999,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1292,17 +1089,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1358,17 +1149,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1463,17 +1248,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1603,17 +1382,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1704,11 +1477,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1720,10 +1489,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1759,11 +1525,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1794,15 +1556,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1884,11 +1641,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1900,11 +1653,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -1932,48 +1681,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -1985,64 +1714,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2061,10 +1770,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2110,11 +1816,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2126,10 +1828,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2152,23 +1851,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2538,10 +2228,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2614,17 +2301,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2645,10 +2326,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2686,10 +2364,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2705,11 +2380,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2754,11 +2425,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3005,11 +2672,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3019,72 +2682,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3105,22 +2737,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3157,11 +2781,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3198,17 +2818,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3220,20 +2834,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3247,20 +2854,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/components/securityscheme.json b/schemas/3.2/components/securityscheme.json index 22d87ba..8146d7c 100644 --- a/schemas/3.2/components/securityscheme.json +++ b/schemas/3.2/components/securityscheme.json @@ -4,72 +4,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -90,22 +59,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----", @@ -117,9 +78,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -136,9 +95,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -253,18 +210,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -276,33 +226,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -330,23 +272,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -358,38 +291,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -401,11 +321,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -418,17 +334,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -440,17 +350,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -471,17 +377,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -496,41 +396,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -557,19 +442,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -631,11 +510,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -651,24 +526,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -688,10 +554,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -730,10 +593,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -755,11 +615,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -771,32 +627,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -808,64 +652,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -894,19 +712,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -926,10 +738,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -972,18 +781,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1032,17 +834,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1118,17 +914,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1138,60 +928,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1277,17 +1041,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1373,17 +1131,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1439,17 +1191,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1544,17 +1290,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1684,17 +1424,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1785,11 +1519,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1801,10 +1531,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1840,11 +1567,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1875,15 +1598,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1965,11 +1683,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -1981,11 +1695,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -2013,48 +1723,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2066,64 +1756,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2142,10 +1812,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2191,11 +1858,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2207,10 +1870,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2233,23 +1893,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2619,10 +2270,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2695,17 +2343,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2726,10 +2368,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2767,10 +2406,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2786,11 +2422,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2835,11 +2467,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3086,11 +2714,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3100,72 +2724,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3186,22 +2779,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3238,11 +2823,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3279,17 +2860,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3301,20 +2876,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3328,20 +2896,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/schemas/3.2/index.ts b/schemas/3.2/index.ts index 9014445..cb2bc5a 100644 --- a/schemas/3.2/index.ts +++ b/schemas/3.2/index.ts @@ -49,4 +49,3 @@ export const schemas = { callback, pathitem, } as const; - diff --git a/schemas/3.2/main/specification.json b/schemas/3.2/main/specification.json index 7bb48c6..b0a854b 100644 --- a/schemas/3.2/main/specification.json +++ b/schemas/3.2/main/specification.json @@ -6,9 +6,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -25,9 +23,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -142,18 +138,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----", @@ -165,9 +154,7 @@ "type": "string", "description": "This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret the OpenAPI document. This is not related to the API `info.version` string. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", "markdownDescription": "This string MUST be the version number of the OpenAPI Specification that the\nOpenAPI document uses. The `openapi` field SHOULD be used by tooling to interpret\nthe OpenAPI document. This is not related to the API `info.version` string.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - openapi } |", - "examples": [ - "3.2.0" - ] + "examples": ["3.2.0"] }, "info": { "$ref": "#/definitions/Info", @@ -184,9 +171,7 @@ "type": "string", "description": "The default value for the `$schema` keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", "markdownDescription": "The default value for the `$schema` keyword within Schema Objects contained\nwithin this OAS document. This MUST be in the form of a URI.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object - jsonSchemaDialect } |", - "examples": [ - "https://json-schema.org/draft/2020-12/schema" - ] + "examples": ["https://json-schema.org/draft/2020-12/schema"] }, "servers": { "type": "array", @@ -301,18 +286,11 @@ ] } }, - "required": [ - "openapi", - "info" - ], + "required": ["openapi", "info"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information needed to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOpenAPI Specification\n-----\n\nThis is the root object of the OpenAPI document. It contains all the information\nneeded to describe an API, including metadata, servers, paths, components, and more.\n\nThe OpenAPI Specification (OAS) defines a standard, language-agnostic interface\nto RESTful APIs which allows both humans and computers to discover and understand\nthe capabilities of the service without access to source code, documentation, or\nthrough network traffic inspection.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#openapi-object OpenAPI 3.2.0 OpenAPI Object } |\n\n-----\nFields\n-----" @@ -324,33 +302,25 @@ "type": "string", "description": "The title of the API. This field is required and should be descriptive of the API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", "markdownDescription": "The title of the API.\nThis field is required and should be descriptive of the API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - title } |", - "examples": [ - "Pet Store API" - ] + "examples": ["Pet Store API"] }, "summary": { "type": "string", "description": "A short summary of the API. This should be a brief description of what the API does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", "markdownDescription": "A short summary of the API.\nThis should be a brief description of what the API does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - summary } |", - "examples": [ - "A sample API that uses a petstore as an example" - ] + "examples": ["A sample API that uses a petstore as an example"] }, "description": { "type": "string", "description": "A description of the API. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", "markdownDescription": "A description of the API.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - description } |", - "examples": [ - "This is a sample server Petstore server." - ] + "examples": ["This is a sample server Petstore server."] }, "termsOfService": { "type": "string", "description": "A URL to the Terms of Service for the API. This MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", "markdownDescription": "A URL to the Terms of Service for the API.\nThis MUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - termsOfService } |", - "examples": [ - "http://example.com/terms/" - ] + "examples": ["http://example.com/terms/"] }, "contact": { "$ref": "#/definitions/Contact", @@ -378,23 +348,14 @@ "type": "string", "description": "The version of the OpenAPI document. This field is required and should follow semantic versioning.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", "markdownDescription": "The version of the OpenAPI document.\nThis field is required and should follow semantic versioning.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object - version } |", - "examples": [ - "1.0.0" - ] + "examples": ["1.0.0"] } }, - "required": [ - "title", - "version" - ], + "required": ["title", "version"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Info Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling as required. The object may be extended with Specification Extensions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInfo Object\n-----\n\nThe object provides metadata about the API. The metadata MAY be used by tooling\nas required. The object may be extended with Specification Extensions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#info-object OpenAPI 3.2.0 Info Object } |\n\n-----\nFields\n-----" @@ -406,38 +367,25 @@ "type": "string", "description": "The identifying name of the contact person/organization.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", "markdownDescription": "The identifying name of the contact person/organization.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - name } |", - "examples": [ - "API Support", - "John Doe" - ] + "examples": ["API Support", "John Doe"] }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", "markdownDescription": "The URL pointing to the contact information.\nMUST be in the format of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - url } |", - "examples": [ - "http://www.acme.com/support", - "https://example.com/contact" - ] + "examples": ["http://www.acme.com/support", "https://example.com/contact"] }, "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", "markdownDescription": "The email address of the contact person/organization.\nMUST be in the format of an email address.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact Object - email } |", - "examples": [ - "support@acme.com", - "contact@example.com" - ] + "examples": ["support@acme.com", "contact@example.com"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Contact Object\n-----\n\nThe Contact Object provides contact information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n----- Fields\n-----", "markdownDescription": "-----\nContact Object\n-----\n\nThe Contact Object provides contact information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#contact-object OpenAPI 3.2.0 Contact } |\n\n-----\nFields\n-----" @@ -449,11 +397,7 @@ "type": "string", "description": "The license name used for the API. This field is required.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", "markdownDescription": "The license name used for the API.\nThis field is required.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License Object - name } |", - "examples": [ - "Apache 2.0", - "MIT", - "Proprietary License" - ] + "examples": ["Apache 2.0", "MIT", "Proprietary License"] }, "url": { "type": "string", @@ -466,17 +410,11 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- License Object\n-----\n\nThe License Object provides license information for the exposed API. It appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLicense Object\n-----\n\nThe License Object provides license information for the exposed API.\nIt appears in the OpenAPI and Swagger specifications from v2.0 through v3.2.x.\n\nSpecification Extensions (`x-*`) are always allowed.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#license-object OpenAPI 3.2.0 License } |\n\n-----\nFields\n-----" @@ -488,17 +426,13 @@ "type": "string", "description": "A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", "markdownDescription": "A URL to the target host.\nThis URL supports Server Variables and MAY be relative, to indicate that the host\nlocation is relative to the location where the OpenAPI document is being served.\nVariable substitutions will be made when a variable is named in {brackets}.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - url } |", - "examples": [ - "https://api.example.com/v1" - ] + "examples": ["https://api.example.com/v1"] }, "description": { "type": "string", "description": "An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", "markdownDescription": "An optional string describing the host designated by the URL.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object - description } |", - "examples": [ - "The production API server" - ] + "examples": ["The production API server"] }, "variables": { "type": "object", @@ -519,17 +453,11 @@ ] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Object\n-----\n\nAn object representing a Server.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-object OpenAPI 3.2.0 Server Object } |\n\n-----\nFields\n-----" @@ -544,41 +472,26 @@ }, "description": "An enumeration of string values to be used if the substitution options are from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", "markdownDescription": "An enumeration of string values to be used if the substitution options\nare from a limited set. The array SHOULD NOT be empty.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - enum } |", - "examples": [ - [ - "8443", - "443" - ] - ] + "examples": [["8443", "443"]] }, "default": { "type": "string", "description": "The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", "markdownDescription": "The default value to use for substitution, which SHALL be sent if an\nalternate value is not supplied. Note this behavior is different than\nthe Schema Object's treatment of default values, because in those cases\nparameter values are optional.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - default } |", - "examples": [ - "demo" - ] + "examples": ["demo"] }, "description": { "type": "string", "description": "An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", "markdownDescription": "An optional description for the server variable.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object - description } |", - "examples": [ - "this value is assigned by the service provider" - ] + "examples": ["this value is assigned by the service provider"] } }, - "required": [ - "default" - ], + "required": ["default"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Server Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nServer Variable Object\n-----\n\nAn object representing a Server Variable for server URL template substitution.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#server-variable-object OpenAPI 3.2.0 Server Variable Object } |\n\n-----\nFields\n-----" @@ -605,19 +518,13 @@ "type": "string", "description": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", "markdownDescription": "An optional, string summary, intended to apply to all operations in this path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - summary } |", - "examples": [ - "Pet operations", - "User management" - ] + "examples": ["Pet operations", "User management"] }, "description": { "type": "string", "description": "An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", "markdownDescription": "An optional, string description, intended to apply to all operations in this path.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object - description } |", - "examples": [ - "Operations related to pet management", - "All user-related operations" - ] + "examples": ["Operations related to pet management", "All user-related operations"] }, "get": { "$ref": "#/definitions/Operation", @@ -679,11 +586,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Path Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nPath Item Object\n-----\n\nDescribes the operations available on a single path. A Path Item MAY be empty,\ndue to ACL constraints. The path itself is still exposed to the documentation\nviewer but they will not know which operations and parameters are available.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#path-item-object OpenAPI 3.2.0 Path Item Object } |\n\n-----\nFields\n-----" @@ -699,24 +602,15 @@ "description": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "markdownDescription": "A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - tags } |", "examples": [ - [ - "pets", - "list" - ], - [ - "users", - "authentication" - ] + ["pets", "list"], + ["users", "authentication"] ] }, "summary": { "type": "string", "description": "A short summary of what the operation does.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", "markdownDescription": "A short summary of what the operation does.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - summary } |", - "examples": [ - "List all pets", - "Create a new user" - ] + "examples": ["List all pets", "Create a new user"] }, "description": { "type": "string", @@ -736,10 +630,7 @@ "type": "string", "description": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", "markdownDescription": "Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - operationId } |", - "examples": [ - "listPets", - "createUser" - ] + "examples": ["listPets", "createUser"] }, "parameters": { "type": "array", @@ -778,10 +669,7 @@ "type": "boolean", "description": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", "markdownDescription": "Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "security": { "type": "array", @@ -803,11 +691,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Operation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOperation Object\n-----\n\nDescribes a single API operation on a path.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#operation-object OpenAPI 3.2.0 Operation Object } |\n\n-----\nFields\n-----" @@ -819,32 +703,20 @@ "type": "string", "description": "A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description of the target documentation. CommonMark syntax MAY be used\nfor rich text representation.", - "examples": [ - "Find out more about our API", - "Additional documentation for this endpoint" - ] + "examples": ["Find out more about our API", "Additional documentation for this endpoint"] }, "url": { "type": "string", "description": "The URL for the target documentation. This field is required and MUST be in the format of a URL.", "markdownDescription": "The URL for the target documentation. This field is required and MUST be in the\nformat of a URL.", - "examples": [ - "https://example.com/docs", - "https://docs.example.com/api" - ] + "examples": ["https://example.com/docs", "https://docs.example.com/api"] } }, - "required": [ - "url" - ], + "required": ["url"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- External Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExternal Documentation Object\n-----\n\nAllows referencing an external resource for extended documentation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#external-documentation-object OpenAPI 3.2.0 External Documentation Object } |\n\n-----\nFields\n-----" @@ -856,64 +728,38 @@ "type": "string", "description": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", "markdownDescription": "The name of the parameter. Parameter names are case sensitive.\n- If in is \"path\", the name field MUST correspond to the associated path segment\n- If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored\n- For all other cases, the name corresponds to the parameter name used by the in property\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - name } |", - "examples": [ - "id", - "limit", - "user" - ] + "examples": ["id", "limit", "user"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "path", - "cookie" - ], + "enum": ["query", "header", "path", "cookie"], "description": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", "markdownDescription": "The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n\n- **query**: Parameters that are appended to the URL\n- **header**: Custom headers that are expected as part of the request\n- **path**: Used together with Path Templating, where the parameter value is actually part of the operation's URL\n- **cookie**: Used to pass a specific cookie value to the API\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - in } |", - "examples": [ - "query", - "path", - "header", - "cookie" - ] + "examples": ["query", "path", "header", "cookie"] }, "description": { "type": "string", "description": "A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", "markdownDescription": "A brief description of the parameter. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - description } |", - "examples": [ - "User ID to retrieve", - "Number of items to return" - ] + "examples": ["User ID to retrieve", "Number of items to return"] }, "required": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", "markdownDescription": "Determines whether this parameter is mandatory. If the parameter location is \"path\",\nthis property is REQUIRED and its value MUST be true. Otherwise, the property MAY be\nincluded and its default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", "markdownDescription": "Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued parameters. This is valid only for query\nparameters and allows sending a parameter with an empty value. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", @@ -942,19 +788,13 @@ "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", "markdownDescription": "When this is true, parameter values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of parameters\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only\napplies to parameters with an in value of query. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -974,10 +814,7 @@ "example": { "description": "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.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", "markdownDescription": "Example of the media type. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -1020,18 +857,11 @@ ] } }, - "required": [ - "name", - "in" - ], + "required": ["name", "in"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Parameter Object\n-----\n\nDescribes a single operation parameter. A unique parameter is defined by a combination of a name and location.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nParameter Object\n-----\n\nDescribes a single operation parameter.\nA unique parameter is defined by a combination of a name and location.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#parameter-object OpenAPI 3.2.0 Parameter Object } |\n\n-----\nFields\n-----" @@ -1080,17 +910,11 @@ "markdownDescription": "A description of the referenced schema.\nCommonMark syntax MAY be used for rich text representation.\n\nExample: `\"Reference to a user schema\"`" } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Reference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`, no other sibling keys are allowed except `description` and extensions. This enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Schema\n-----\n\nA schema that references another schema. When a schema contains `$ref`,\nno other sibling keys are allowed except `description` and extensions.\nThis enforces the OpenAPI 3.2.0 rule that `$ref` is exclusive with other properties.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -1166,17 +990,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userName\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- String Schema\n-----\n\nA schema for string values. Includes string-specific validation properties that are only valid when `type: \"string\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nString Schema\n-----\n\nA schema for string values. Includes string-specific validation properties\nthat are only valid when `type: \"string\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1186,60 +1004,34 @@ "properties": { "nodeType": { "type": "string", - "enum": [ - "element", - "attribute", - "text", - "cdata", - "none" - ], + "enum": ["element", "attribute", "text", "cdata", "none"], "description": "The type of XML node this schema produces. Determines how the schema is serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", "markdownDescription": "The type of XML node this schema produces. Determines how the schema\nis serialized to XML.\n\n- `\"element\"`: Produces an XML element node (may contain attributes, child elements, or text)\n- `\"attribute\"`: Produces an XML attribute node on the containing element (value-only)\n- `\"text\"`: Contributes character data of the containing element (PCDATA)\n- `\"cdata\"`: Contributes a CDATA section of the containing element\n- `\"none\"`: Does not directly produce a node (used for structural control, e.g., array wrappers)", - "examples": [ - "element", - "attribute", - "text", - "cdata", - "none" - ] + "examples": ["element", "attribute", "text", "cdata", "none"] }, "name": { "type": "string", "description": "Replaces the name of the element/attribute used for the described schema property. Only effective when `nodeType` is \"element\" or \"attribute\". When defined within the Items Object (items), it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element name.", "markdownDescription": "Replaces the name of the element/attribute used for the described schema property.\nOnly effective when `nodeType` is \"element\" or \"attribute\". When defined within\nthe Items Object (items), it will affect the name of the individual XML elements\nwithin the list. When defined alongside type being array (outside the items),\nit will affect the wrapping element name.", - "examples": [ - "user", - "id", - "users" - ] + "examples": ["user", "id", "users"] }, "namespace": { "type": "string", "description": "The URI of the namespace definition. This MUST be in the form of an absolute URI. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The URI of the namespace definition. This MUST be in the form of an absolute URI.\nOnly effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "http://example.com/schema/user", - "http://www.w3.org/XML/1998/namespace" - ] + "examples": ["http://example.com/schema/user", "http://www.w3.org/XML/1998/namespace"] }, "prefix": { "type": "string", "description": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", "markdownDescription": "The prefix to be used for the name. Only effective when `nodeType` is \"element\" or \"attribute\".", - "examples": [ - "user", - "xml" - ] + "examples": ["user", "xml"] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- XML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions. OpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType` to replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms) and the `name` property SHOULD be used to add that information.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nXML Object\n-----\n\nA metadata object that allows for more fine-tuned XML model definitions.\nOpenAPI 3.2.0 introduces a modernized XML modeling approach using `nodeType`\nto replace the deprecated `attribute` and `wrapped` fields from earlier versions.\n\nWhen using arrays, XML element names are not inferred (for singular/plural forms)\nand the `name` property SHOULD be used to add that information.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#xml-object OpenAPI 3.2.0 XML Object } |\n\n-----\nFields\n-----" @@ -1325,17 +1117,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"price\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Number Schema\n-----\n\nA schema for number values. Includes number-specific validation properties that are only valid when `type: \"number\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nNumber Schema\n-----\n\nA schema for number values. Includes number-specific validation properties\nthat are only valid when `type: \"number\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1421,17 +1207,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"userId\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Integer Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties that are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nInteger Schema\n-----\n\nA schema for integer values. Includes integer-specific validation properties\nthat are only valid when `type: \"integer\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1487,17 +1267,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"isActive\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Boolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties that are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nBoolean Schema\n-----\n\nA schema for boolean values. Includes common validation properties\nthat are only valid when `type: \"boolean\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1592,17 +1366,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"users\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Array Schema\n-----\n\nA schema for array values. Includes array-specific validation properties that are only valid when `type: \"array\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nArray Schema\n-----\n\nA schema for array values. Includes array-specific validation properties\nthat are only valid when `type: \"array\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1732,17 +1500,11 @@ "markdownDescription": "XML representation metadata for the schema.\nAllows for fine-tuned XML model definitions using the modernized\nnodeType approach in OpenAPI 3.2.0.\n\nExample: `{ nodeType: \"element\", name: \"user\" }`" } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Object Schema\n-----\n\nA schema for object values. Includes object-specific validation properties that are only valid when `type: \"object\"` is specified.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n----- Fields\n-----", "markdownDescription": "-----\nObject Schema\n-----\n\nA schema for object values. Includes object-specific validation properties\nthat are only valid when `type: \"object\"` is specified.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#data-types OpenAPI 3.2.0 Data Types } |\n\n-----\nFields\n-----" @@ -1833,11 +1595,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Composition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not). These keywords are mutually exclusive with $ref, but otherwise can appear with any validation keywords. This schema type supports advanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComposition Schema\n-----\n\nA schema that uses composition keywords (allOf, anyOf, oneOf, not).\nThese keywords are mutually exclusive with $ref, but otherwise can\nappear with any validation keywords. This schema type supports\nadvanced JSON Schema 2020-12 features like conditional schemas.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#schema-object OpenAPI 3.2.0 Schema Object } |\n\n-----\nFields\n-----" @@ -1849,10 +1607,7 @@ "type": "string", "description": "Short description for the example.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", "markdownDescription": "Short description for the example.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object - summary } |", - "examples": [ - "A user example", - "Error response" - ] + "examples": ["A user example", "Error response"] }, "description": { "type": "string", @@ -1888,11 +1643,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Example Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value. Tooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nExample Object\n-----\n\nIn all cases, the example value is expected to be compatible with the type schema of its associated value.\nTooling implementations MAY choose to validate compatibility automatically, and reject the example value(s) if incompatible.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#example-object OpenAPI 3.2.0 Example Object } |\n\n-----\nFields\n-----" @@ -1923,15 +1674,10 @@ "type": "string", "description": "A short summary of the referenced object. This can be used to provide a brief overview of what the referenced object represents.", "markdownDescription": "A short summary of the referenced object. This can be used to provide\na brief overview of what the referenced object represents.", - "examples": [ - "User schema", - "Not found response" - ] + "examples": ["User schema", "Not found response"] } }, - "required": [ - "$ref" - ], + "required": ["$ref"], "additionalProperties": false, "description": "----- Reference Object\n-----\n\nA simple object to allow referencing other components in the specification, internally and externally. The Reference Object is a special JSON object that allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present, the Reference Object is the only property that should be present (except for `description` and specification extensions).\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nReference Object\n-----\n\nA simple object to allow referencing other components in the specification,\ninternally and externally. The Reference Object is a special JSON object\nthat allows you to reference other parts of the OpenAPI specification.\n\nThe `$ref` keyword is used to reference other components, and when present,\nthe Reference Object is the only property that should be present (except\nfor `description` and specification extensions).\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#reference-object OpenAPI 3.2.0 Reference Object } |\n\n-----\nFields\n-----" @@ -2013,11 +1759,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Media Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nMedia Type Object\n-----\n\nEach Media Type Object provides schema and examples for the media type identified by its key.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#media-type-object OpenAPI 3.2.0 Media Type Object } |\n\n-----\nFields\n-----" @@ -2029,11 +1771,7 @@ "type": "string", "description": "The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", "markdownDescription": "The Content-Type for encoding a specific property.\nDefault value depends on the property type: for string with format being binary – application/octet-stream;\nfor other primitive types – text/plain; for object – application/json; for array – the default is defined based on the inner type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - contentType } |", - "examples": [ - "text/plain", - "application/json", - "image/png" - ] + "examples": ["text/plain", "application/json", "image/png"] }, "headers": { "type": "object", @@ -2061,48 +1799,28 @@ }, "style": { "type": "string", - "enum": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ], + "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"], "description": "Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters. Default value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", "markdownDescription": "Describes how a specific property value will be serialized depending on its type.\nSee Parameter Object for details on the style property. The behavior follows the same values as query parameters.\nDefault value depends on the property type: for string with format being binary – binary; for other primitive types – form.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - style } |", - "examples": [ - "form", - "spaceDelimited", - "pipeDelimited", - "deepObject" - ] + "examples": ["form", "spaceDelimited", "pipeDelimited", "deepObject"] }, "explode": { "type": "boolean", "description": "When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", "markdownDescription": "When this is true, property values of type array or object generate separate parameters\nfor each value of the array or key-value pair of the map. For other types of properties\nthis property has no effect. When style is form, the default value is true.\nFor all other styles, the default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", "markdownDescription": "Determines whether the parameter value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Encoding Object\n-----\n\nA single encoding definition applied to a single schema property. The Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nEncoding Object\n-----\n\nA single encoding definition applied to a single schema property.\nThe Encoding Object is used to describe how a specific property value will be serialized.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#encoding-object OpenAPI 3.2.0 Encoding Object } |\n\n-----\nFields\n-----" @@ -2114,64 +1832,44 @@ "type": "string", "description": "A brief description of the header. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", "markdownDescription": "A brief description of the header. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - description } |", - "examples": [ - "Rate limit header", - "Authentication token" - ] + "examples": ["Rate limit header", "Authentication token"] }, "required": { "type": "boolean", "description": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", "markdownDescription": "Determines whether this header is mandatory. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "deprecated": { "type": "boolean", "description": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", "markdownDescription": "Specifies that a header is deprecated and SHOULD be transitioned out of usage.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - deprecated } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowEmptyValue": { "type": "boolean", "description": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", "markdownDescription": "Sets the ability to pass empty-valued headers. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowEmptyValue } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "style": { "type": "string", "const": "simple", "description": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", "markdownDescription": "Describes how the header value will be serialized. Default value is \"simple\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - style } |", - "examples": [ - "simple" - ] + "examples": ["simple"] }, "explode": { "type": "boolean", "description": "When this is true, header values of type array or object generate separate headers for each value of the array or key-value pair of the map. For other types of headers this property has no effect. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", "markdownDescription": "When this is true, header values of type array or object generate separate headers\nfor each value of the array or key-value pair of the map. For other types of headers\nthis property has no effect. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - explode } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "allowReserved": { "type": "boolean", "description": "Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", "markdownDescription": "Determines whether the header value SHOULD allow reserved characters, as defined by\nRFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. Default value is false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - allowReserved } |", - "examples": [ - true, - false - ] + "examples": [true, false] }, "schema": { "$ref": "#/definitions/Schema", @@ -2190,10 +1888,7 @@ "example": { "description": "Example of the header. The example SHOULD match the specified schema and encoding properties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", "markdownDescription": "Example of the header. The example SHOULD match the specified schema and encoding\nproperties if present. The example object is mutually exclusive of the examples object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object - example } |", - "examples": [ - "example-value", - 42 - ] + "examples": ["example-value", 42] }, "examples": { "type": "object", @@ -2239,11 +1934,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Header Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes: 1. `name` MUST NOT be specified, it is given in the corresponding `headers` map 2. `in` MUST NOT be specified, it is implicitly in `header` 3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nHeader Object\n-----\n\nThe Header Object follows the structure of the Parameter Object with the following changes:\n1. `name` MUST NOT be specified, it is given in the corresponding `headers` map\n2. `in` MUST NOT be specified, it is implicitly in `header`\n3. All traits that are affected by the location MUST be applicable to a location of `header` (for example, `style`)\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#header-object OpenAPI 3.2.0 Header Object } |\n\n-----\nFields\n-----" @@ -2255,10 +1946,7 @@ "type": "string", "description": "A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", "markdownDescription": "A brief description of the request body. This could contain examples of use.\nCommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - description } |", - "examples": [ - "User data", - "Pet information to add to the store" - ] + "examples": ["User data", "Pet information to add to the store"] }, "content": { "type": "object", @@ -2281,23 +1969,14 @@ "type": "boolean", "description": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", "markdownDescription": "Determines if the request body is required in the request. Defaults to false.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object - required } |", - "examples": [ - true, - false - ] + "examples": [true, false] } }, - "required": [ - "content" - ], + "required": ["content"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Request Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nRequest Body Object\n-----\n\nDescribes a single request body.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#request-body-object OpenAPI 3.2.0 Request Body Object } |\n\n-----\nFields\n-----" @@ -2667,10 +2346,7 @@ "type": "string", "description": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", "markdownDescription": "A short description of the response. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object - description } |", - "examples": [ - "A list of pets", - "User created successfully" - ] + "examples": ["A list of pets", "User created successfully"] }, "headers": { "type": "object", @@ -2743,17 +2419,11 @@ ] } }, - "required": [ - "description" - ], + "required": ["description"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Response Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nResponse Object\n-----\n\nDescribes a single response from an API Operation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#response-object OpenAPI 3.2.0 Response Object } |\n\n-----\nFields\n-----" @@ -2774,10 +2444,7 @@ "type": "string", "description": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", "markdownDescription": "The name of an existing, resolvable OAS operation. This field is mutually exclusive of the operationRef field.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - operationId } |", - "examples": [ - "getUserRepositories", - "getUserById" - ] + "examples": ["getUserRepositories", "getUserById"] }, "parameters": { "type": "object", @@ -2815,10 +2482,7 @@ "type": "string", "description": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", "markdownDescription": "A description of the link. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object - description } |", - "examples": [ - "Link to user repositories", - "Link to user profile" - ] + "examples": ["Link to user repositories", "Link to user profile"] }, "server": { "$ref": "#/definitions/Server", @@ -2834,11 +2498,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Link Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nLink Object\n-----\n\nThe Link object represents a possible design-time link for a response. The presence of a link does not guarantee\nthe caller's ability to successfully invoke it, rather it provides a known relationship and traversal mechanism\nbetween responses and other operations.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#link-object OpenAPI 3.2.0 Link Object } |\n\n-----\nFields\n-----" @@ -2883,11 +2543,7 @@ { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] } ] }, @@ -3134,11 +2790,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Components Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nComponents Object\n-----\n\nHolds a set of reusable objects for different aspects of the OAS. All objects defined\nwithin the components object will have no effect on the API unless they are explicitly\nreferenced from properties outside the components object.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#components-object OpenAPI 3.2.0 Components Object } |\n\n-----\nFields\n-----" @@ -3148,72 +2800,41 @@ "properties": { "type": { "type": "string", - "enum": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ], + "enum": ["apiKey", "http", "oauth2", "openIdConnect"], "description": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", "markdownDescription": "The type of the security scheme. Valid values are \"apiKey\", \"http\", \"oauth2\", \"openIdConnect\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - type } |", - "examples": [ - "apiKey", - "http", - "oauth2", - "openIdConnect" - ] + "examples": ["apiKey", "http", "oauth2", "openIdConnect"] }, "description": { "type": "string", "description": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", "markdownDescription": "A short description for security scheme. CommonMark syntax MAY be used for rich text representation.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - description } |", - "examples": [ - "API key authentication", - "OAuth2 authentication" - ] + "examples": ["API key authentication", "OAuth2 authentication"] }, "name": { "type": "string", "description": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", "markdownDescription": "The name of the header, query or cookie parameter to be used.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - name } |", - "examples": [ - "X-API-Key", - "Authorization" - ] + "examples": ["X-API-Key", "Authorization"] }, "in": { "type": "string", - "enum": [ - "query", - "header", - "cookie" - ], + "enum": ["query", "header", "cookie"], "description": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", "markdownDescription": "The location of the API key. Valid values are \"query\", \"header\" or \"cookie\".\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - in } |", - "examples": [ - "query", - "header", - "cookie" - ] + "examples": ["query", "header", "cookie"] }, "scheme": { "type": "string", "description": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", "markdownDescription": "The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - scheme } |", - "examples": [ - "basic", - "bearer", - "digest" - ] + "examples": ["basic", "bearer", "digest"] }, "bearerFormat": { "type": "string", "description": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily generated by an authorization server, so this field is a hint only.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", "markdownDescription": "A hint to the client to identify how the bearer token is formatted. Bearer tokens are not necessarily\ngenerated by an authorization server, so this field is a hint only.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - bearerFormat } |", - "examples": [ - "JWT", - "OAuth2" - ] + "examples": ["JWT", "OAuth2"] }, "flows": { "$ref": "#/definitions/OAuthFlows", @@ -3234,22 +2855,14 @@ "type": "string", "description": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", "markdownDescription": "OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object - openIdConnectUrl } |", - "examples": [ - "https://example.com/.well-known/openid_configuration" - ] + "examples": ["https://example.com/.well-known/openid_configuration"] } }, - "required": [ - "type" - ], + "required": ["type"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Security Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows (implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nSecurity Scheme Object\n-----\n\nDefines a security scheme that can be used by the operations. Supported schemes are HTTP authentication,\nan API key (either as a header, a cookie parameter or as a query parameter), OAuth2's common flows\n(implicit, password, client credentials and authorization code) as defined in RFC6749, and OpenID Connect Discovery.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#security-scheme-object OpenAPI 3.2.0 Security Scheme Object } |\n\n-----\nFields\n-----" @@ -3286,11 +2899,7 @@ "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows. This object describes the OAuth flows that are available for this API.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flows Object\n-----\n\nAllows configuration of the supported OAuth Flows.\nThis object describes the OAuth flows that are available for this API.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flows-object OpenAPI 3.2.0 OAuth Flows Object } |\n\n-----\nFields\n-----" @@ -3327,17 +2936,11 @@ "markdownDescription": "The URL to be used for OAuth 2.0 metadata.\nThis MUST be in the form of a URL.\n\nExample: `\"https://example.com/.well-known/oauth-authorization-server\"`" } }, - "required": [ - "scopes" - ], + "required": ["scopes"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- OAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow. This object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nOAuth Flow Object\n-----\n\nConfiguration details for a supported OAuth Flow.\nThis object describes the OAuth flow configuration for a specific OAuth flow type.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#oauth-flow-object OpenAPI 3.2.0 OAuth Flow Object } |\n\n-----\nFields\n-----" @@ -3349,20 +2952,13 @@ "type": "string", "description": "The name of the tag. This field is required.", "markdownDescription": "The name of the tag. This field is required.", - "examples": [ - "users", - "pets", - "authentication" - ] + "examples": ["users", "pets", "authentication"] }, "description": { "type": "string", "description": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", "markdownDescription": "A short description for the tag. CommonMark syntax MAY be used for rich text representation.", - "examples": [ - "User management operations", - "Pet store operations" - ] + "examples": ["User management operations", "Pet store operations"] }, "externalDocs": { "$ref": "#/definitions/ExternalDocumentation", @@ -3376,20 +2972,14 @@ ] } }, - "required": [ - "name" - ], + "required": ["name"], "additionalProperties": { "description": "Specification Extensions allow adding custom properties to OpenAPI objects. All extension properties must start with `x-` and can contain any valid JSON value.", "markdownDescription": "Specification Extensions allow adding custom properties to OpenAPI objects.\nAll extension properties must start with `x-` and can contain any valid JSON value.", - "examples": [ - "x-custom-property", - "x-internal-id", - "x-codegen-settings" - ] + "examples": ["x-custom-property", "x-internal-id", "x-codegen-settings"] }, "description": "----- Tag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object. It is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier for developers to understand and navigate the API. They are commonly used to group operations by resource type, functionality, or any other logical division.\n\n| Version | Reference | |---|-----| | 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n----- Fields\n-----", "markdownDescription": "-----\nTag Object\n-----\n\nAdds metadata to a single tag that is used by the Tag Object.\nIt is not mandatory to have a Tag Object per tag used there.\n\nTags provide a way to organize and categorize API operations, making it easier\nfor developers to understand and navigate the API. They are commonly used to\ngroup operations by resource type, functionality, or any other logical division.\n\n| Version | Reference |\n|---|-----|\n| 3.2.0 | {@link https://spec.openapis.org/oas/v3.2.0#tag-object OpenAPI 3.2.0 Tag Object } |\n\n-----\nFields\n-----" } } -} \ No newline at end of file +} diff --git a/tests/2.0/api-with-examples.ts b/tests/2.0/api-with-examples.ts index 5be0e9b..8e915a7 100644 --- a/tests/2.0/api-with-examples.ts +++ b/tests/2.0/api-with-examples.ts @@ -1,147 +1,147 @@ import type { Specification } from "../../2.0"; export const apiWithExamples: Specification = { - swagger: "2.0", - info: { - title: "Simple API overview", - version: "v2", - }, - paths: { - "/": { - get: { - operationId: "listVersionsv2", - summary: "List API versions", - produces: ["application/json"], - responses: { - "200": { - description: "200 300 response", - examples: { - "application/json": { - versions: [ - { - status: "CURRENT", - updated: "2011-01-21T11:33:21Z", - id: "v2.0", - links: [{ href: "http://127.0.0.1:8774/v2/", rel: "self" }], - }, - { - status: "EXPERIMENTAL", - updated: "2013-07-23T11:33:21Z", - id: "v3.0", - links: [{ href: "http://127.0.0.1:8774/v3/", rel: "self" }], - }, - ], - }, - }, - }, - "300": { - description: "200 300 response", - examples: { - "application/json": { - versions: [ - { - status: "CURRENT", - updated: "2011-01-21T11:33:21Z", - id: "v2.0", - links: [{ href: "http://127.0.0.1:8774/v2/", rel: "self" }], - }, - { - status: "EXPERIMENTAL", - updated: "2013-07-23T11:33:21Z", - id: "v3.0", - links: [{ href: "http://127.0.0.1:8774/v3/", rel: "self" }], - }, - ], - }, - }, - }, - }, - }, - }, - "/v2": { - get: { - operationId: "getVersionDetailsv2", - summary: "Show API version details", - produces: ["application/json"], - responses: { - "200": { - description: "200 203 response", - examples: { - "application/json": { - version: { - status: "CURRENT", - updated: "2011-01 - 21T11: 33: 21Z", - "media - types": [ - { - base: "application / xml", - type: "application / vnd.openstack.compute + xml; version=2", - }, - { - base: "application / json", - type: "application / vnd.openstack.compute + json; version=2", - }, - ], - id: "v2.0", - links: [ - { href: "http://127.0.0.1:8774/v2/", rel: "self" }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", - type: "application/pdf", - rel: "describedby", - }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", - type: "application/vnd.sun.wadl+xml", - rel: "describedby", - }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", - type: "application/vnd.sun.wadl+xml", - rel: "describedby", - }, - ], - }, - }, - }, - }, - "203": { - description: "200 203 response", - examples: { - "application/json": { - version: { - status: "CURRENT", - updated: "2011-01 - 21T11: 33: 21Z", - "media - types": [ - { - base: "application / xml", - type: "application / vnd.openstack.compute + xml; version=2", - }, - { - base: "application / json", - type: "application / vnd.openstack.compute + json; version=2", - }, - ], - id: "v2.0", - links: [ - { href: "http://23.253.228.211:8774/v2/", rel: "self" }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", - type: "application/pdf", - rel: "describedby", - }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", - type: "application/vnd.sun.wadl+xml", - rel: "describedby", - }, - ], - }, - }, - }, - }, - }, - }, - }, - }, - consumes: ["application/json"], + swagger: "2.0", + info: { + title: "Simple API overview", + version: "v2", + }, + paths: { + "/": { + get: { + operationId: "listVersionsv2", + summary: "List API versions", + produces: ["application/json"], + responses: { + "200": { + description: "200 300 response", + examples: { + "application/json": { + versions: [ + { + status: "CURRENT", + updated: "2011-01-21T11:33:21Z", + id: "v2.0", + links: [{ href: "http://127.0.0.1:8774/v2/", rel: "self" }], + }, + { + status: "EXPERIMENTAL", + updated: "2013-07-23T11:33:21Z", + id: "v3.0", + links: [{ href: "http://127.0.0.1:8774/v3/", rel: "self" }], + }, + ], + }, + }, + }, + "300": { + description: "200 300 response", + examples: { + "application/json": { + versions: [ + { + status: "CURRENT", + updated: "2011-01-21T11:33:21Z", + id: "v2.0", + links: [{ href: "http://127.0.0.1:8774/v2/", rel: "self" }], + }, + { + status: "EXPERIMENTAL", + updated: "2013-07-23T11:33:21Z", + id: "v3.0", + links: [{ href: "http://127.0.0.1:8774/v3/", rel: "self" }], + }, + ], + }, + }, + }, + }, + }, + }, + "/v2": { + get: { + operationId: "getVersionDetailsv2", + summary: "Show API version details", + produces: ["application/json"], + responses: { + "200": { + description: "200 203 response", + examples: { + "application/json": { + version: { + status: "CURRENT", + updated: "2011-01 - 21T11: 33: 21Z", + "media - types": [ + { + base: "application / xml", + type: "application / vnd.openstack.compute + xml; version=2", + }, + { + base: "application / json", + type: "application / vnd.openstack.compute + json; version=2", + }, + ], + id: "v2.0", + links: [ + { href: "http://127.0.0.1:8774/v2/", rel: "self" }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", + type: "application/pdf", + rel: "describedby", + }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", + type: "application/vnd.sun.wadl+xml", + rel: "describedby", + }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", + type: "application/vnd.sun.wadl+xml", + rel: "describedby", + }, + ], + }, + }, + }, + }, + "203": { + description: "200 203 response", + examples: { + "application/json": { + version: { + status: "CURRENT", + updated: "2011-01 - 21T11: 33: 21Z", + "media - types": [ + { + base: "application / xml", + type: "application / vnd.openstack.compute + xml; version=2", + }, + { + base: "application / json", + type: "application / vnd.openstack.compute + json; version=2", + }, + ], + id: "v2.0", + links: [ + { href: "http://23.253.228.211:8774/v2/", rel: "self" }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", + type: "application/pdf", + rel: "describedby", + }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", + type: "application/vnd.sun.wadl+xml", + rel: "describedby", + }, + ], + }, + }, + }, + }, + }, + }, + }, + }, + consumes: ["application/json"], }; diff --git a/tests/2.0/petstore-expanded.ts b/tests/2.0/petstore-expanded.ts index 0cabf1b..ed20b81 100644 --- a/tests/2.0/petstore-expanded.ts +++ b/tests/2.0/petstore-expanded.ts @@ -1,204 +1,204 @@ import type { Specification } from "../../2.0"; const petstoreExpanded: Specification = { - swagger: "2.0", - info: { - version: "1.0.0", - title: "Swagger Petstore", - description: - "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", - termsOfService: "http://swagger.io/terms/", - contact: { - name: "Swagger API Team", - email: "apiteam@swagger.io", - url: "http://swagger.io", - }, - license: { - name: "Apache 2.0", - url: "https://www.apache.org/licenses/LICENSE-2.0.html", - }, - }, - host: "petstore.swagger.io", - basePath: "/api", - schemes: ["http"], - consumes: ["application/json"], - produces: ["application/json"], - paths: { - "/pets": { - get: { - description: - "Returns all pets from the system that the user has access to\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\n\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\n", - operationId: "findPets", - parameters: [ - { - name: "tags", - in: "query", - description: "tags to filter by", - required: false, - type: "array", - collectionFormat: "csv", - items: { - type: "string", - }, - }, - { - name: "limit", - in: "query", - description: "maximum number of results to return", - required: false, - type: "integer", - format: "int32", - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - type: "array", - items: { - $ref: "#/definitions/Pet", - }, - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - post: { - description: "Creates a new pet in the store. Duplicates are allowed", - operationId: "addPet", - parameters: [ - { - name: "pet", - in: "body", - description: "Pet to add to the store", - required: true, - schema: { - $ref: "#/definitions/NewPet", - }, - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - $ref: "#/definitions/Pet", - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - "/pets/{id}": { - get: { - description: - "Returns a user based on a single ID, if the user does not have access to the pet", - operationId: "find pet by id", - parameters: [ - { - name: "id", - in: "path", - description: "ID of pet to fetch", - required: true, - type: "integer", - format: "int64", - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - $ref: "#/definitions/Pet", - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - delete: { - description: "deletes a single pet based on the ID supplied", - operationId: "deletePet", - parameters: [ - { - name: "id", - in: "path", - description: "ID of pet to delete", - required: true, - type: "integer", - format: "int64", - }, - ], - responses: { - 204: { - description: "pet deleted", - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - }, - definitions: { - Pet: { - type: "object", - allOf: [ - { - $ref: "#/definitions/NewPet", - }, - { - required: ["id"], - properties: { - id: { - type: "integer", - format: "int64", - }, - }, - }, - ], - }, - NewPet: { - type: "object", - required: ["name"], - properties: { - name: { - type: "string", - }, - tag: { - type: "string", - }, - }, - }, - Error: { - type: "object", - required: ["code", "message"], - properties: { - code: { - type: "integer", - format: "int32", - }, - message: { - type: "string", - }, - }, - }, - }, + swagger: "2.0", + info: { + version: "1.0.0", + title: "Swagger Petstore", + description: + "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + termsOfService: "http://swagger.io/terms/", + contact: { + name: "Swagger API Team", + email: "apiteam@swagger.io", + url: "http://swagger.io", + }, + license: { + name: "Apache 2.0", + url: "https://www.apache.org/licenses/LICENSE-2.0.html", + }, + }, + host: "petstore.swagger.io", + basePath: "/api", + schemes: ["http"], + consumes: ["application/json"], + produces: ["application/json"], + paths: { + "/pets": { + get: { + description: + "Returns all pets from the system that the user has access to\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\n\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\n", + operationId: "findPets", + parameters: [ + { + name: "tags", + in: "query", + description: "tags to filter by", + required: false, + type: "array", + collectionFormat: "csv", + items: { + type: "string", + }, + }, + { + name: "limit", + in: "query", + description: "maximum number of results to return", + required: false, + type: "integer", + format: "int32", + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + type: "array", + items: { + $ref: "#/definitions/Pet", + }, + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + post: { + description: "Creates a new pet in the store. Duplicates are allowed", + operationId: "addPet", + parameters: [ + { + name: "pet", + in: "body", + description: "Pet to add to the store", + required: true, + schema: { + $ref: "#/definitions/NewPet", + }, + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + $ref: "#/definitions/Pet", + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + "/pets/{id}": { + get: { + description: + "Returns a user based on a single ID, if the user does not have access to the pet", + operationId: "find pet by id", + parameters: [ + { + name: "id", + in: "path", + description: "ID of pet to fetch", + required: true, + type: "integer", + format: "int64", + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + $ref: "#/definitions/Pet", + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + delete: { + description: "deletes a single pet based on the ID supplied", + operationId: "deletePet", + parameters: [ + { + name: "id", + in: "path", + description: "ID of pet to delete", + required: true, + type: "integer", + format: "int64", + }, + ], + responses: { + 204: { + description: "pet deleted", + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + }, + definitions: { + Pet: { + type: "object", + allOf: [ + { + $ref: "#/definitions/NewPet", + }, + { + required: ["id"], + properties: { + id: { + type: "integer", + format: "int64", + }, + }, + }, + ], + }, + NewPet: { + type: "object", + required: ["name"], + properties: { + name: { + type: "string", + }, + tag: { + type: "string", + }, + }, + }, + Error: { + type: "object", + required: ["code", "message"], + properties: { + code: { + type: "integer", + format: "int32", + }, + message: { + type: "string", + }, + }, + }, + }, }; export { petstoreExpanded }; diff --git a/tests/2.0/petstore-minimal.ts b/tests/2.0/petstore-minimal.ts index f71300b..4b7b308 100644 --- a/tests/2.0/petstore-minimal.ts +++ b/tests/2.0/petstore-minimal.ts @@ -1,61 +1,60 @@ import type { Specification } from "../../2.0"; export const petstoreMinimal: Specification = { - swagger: "2.0", - info: { - version: "1.0.0", - title: "Swagger Petstore", - description: - "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", - termsOfService: "http://swagger.io/terms/", - contact: { - name: "Swagger API Team", - }, - license: { - name: "MIT", - }, - }, - host: "petstore.swagger.io", - basePath: "/api", - schemes: ["http"], - consumes: ["application/json"], - produces: ["application/json"], - paths: { - "/pets": { - get: { - description: - "Returns all pets from the system that the user has access to", - produces: ["application/json"], - responses: { - 200: { - description: "A list of pets.", - schema: { - type: "array", - items: { - $ref: "#/definitions/Pet", - }, - }, - }, - }, - }, - }, - }, - definitions: { - Pet: { - type: "object", - required: ["id", "name"], - properties: { - id: { - type: "integer", - format: "int64", - }, - name: { - type: "string", - }, - tag: { - type: "string", - }, - }, - }, - }, + swagger: "2.0", + info: { + version: "1.0.0", + title: "Swagger Petstore", + description: + "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + termsOfService: "http://swagger.io/terms/", + contact: { + name: "Swagger API Team", + }, + license: { + name: "MIT", + }, + }, + host: "petstore.swagger.io", + basePath: "/api", + schemes: ["http"], + consumes: ["application/json"], + produces: ["application/json"], + paths: { + "/pets": { + get: { + description: "Returns all pets from the system that the user has access to", + produces: ["application/json"], + responses: { + 200: { + description: "A list of pets.", + schema: { + type: "array", + items: { + $ref: "#/definitions/Pet", + }, + }, + }, + }, + }, + }, + }, + definitions: { + Pet: { + type: "object", + required: ["id", "name"], + properties: { + id: { + type: "integer", + format: "int64", + }, + name: { + type: "string", + }, + tag: { + type: "string", + }, + }, + }, + }, }; diff --git a/tests/2.0/petstore-simple.ts b/tests/2.0/petstore-simple.ts index c50832a..f9fb1dd 100644 --- a/tests/2.0/petstore-simple.ts +++ b/tests/2.0/petstore-simple.ts @@ -1,212 +1,201 @@ import type { Specification } from "../../2.0"; export const petstoreSimple: Specification = { - swagger: "2.0", - info: { - version: "1.0.0", - title: "Swagger Petstore", - description: - "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", - termsOfService: "http://swagger.io/terms/", - contact: { - name: "Swagger API Team", - }, - license: { - name: "MIT", - }, - }, - host: "petstore.swagger.io", - basePath: "/api", - schemes: ["http"], - consumes: ["application/json"], - produces: ["application/json"], - paths: { - "/pets": { - get: { - description: - "Returns all pets from the system that the user has access to", - operationId: "findPets", - produces: [ - "application/json", - "application/xml", - "text/xml", - "text/html", - ], - parameters: [ - { - name: "tags", - in: "query", - description: "tags to filter by", - required: false, - type: "array", - items: { - type: "string", - }, - collectionFormat: "csv", - }, - { - name: "limit", - in: "query", - description: "maximum number of results to return", - required: false, - type: "integer", - format: "int32", - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - type: "array", - items: { - $ref: "#/definitions/Pet", - }, - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/ErrorModel", - }, - }, - }, - }, - post: { - description: "Creates a new pet in the store. Duplicates are allowed", - operationId: "addPet", - produces: ["application/json"], - parameters: [ - { - name: "pet", - in: "body", - description: "Pet to add to the store", - required: true, - schema: { - $ref: "#/definitions/NewPet", - }, - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - $ref: "#/definitions/Pet", - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/ErrorModel", - }, - }, - }, - }, - }, - "/pets/{id}": { - get: { - description: - "Returns a user based on a single ID, if the user does not have access to the pet", - operationId: "findPetById", - produces: [ - "application/json", - "application/xml", - "text/xml", - "text/html", - ], - parameters: [ - { - name: "id", - in: "path", - description: "ID of pet to fetch", - required: true, - type: "integer", - format: "int64", - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - $ref: "#/definitions/Pet", - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/ErrorModel", - }, - }, - }, - }, - delete: { - description: "deletes a single pet based on the ID supplied", - operationId: "deletePet", - parameters: [ - { - name: "id", - in: "path", - description: "ID of pet to delete", - required: true, - type: "integer", - format: "int64", - }, - ], - responses: { - 204: { - description: "pet deleted", - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/ErrorModel", - }, - }, - }, - }, - }, - }, - definitions: { - Pet: { - type: "object", - allOf: [ - { - $ref: "#/definitions/NewPet", - }, - { - required: ["id"], - properties: { - id: { - type: "integer", - format: "int64", - }, - }, - }, - ], - }, - NewPet: { - type: "object", - required: ["name"], - properties: { - name: { - type: "string", - }, - tag: { - type: "string", - }, - }, - }, - ErrorModel: { - type: "object", - required: ["code", "message"], - properties: { - code: { - type: "integer", - format: "int32", - }, - message: { - type: "string", - }, - }, - }, - }, + swagger: "2.0", + info: { + version: "1.0.0", + title: "Swagger Petstore", + description: + "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + termsOfService: "http://swagger.io/terms/", + contact: { + name: "Swagger API Team", + }, + license: { + name: "MIT", + }, + }, + host: "petstore.swagger.io", + basePath: "/api", + schemes: ["http"], + consumes: ["application/json"], + produces: ["application/json"], + paths: { + "/pets": { + get: { + description: "Returns all pets from the system that the user has access to", + operationId: "findPets", + produces: ["application/json", "application/xml", "text/xml", "text/html"], + parameters: [ + { + name: "tags", + in: "query", + description: "tags to filter by", + required: false, + type: "array", + items: { + type: "string", + }, + collectionFormat: "csv", + }, + { + name: "limit", + in: "query", + description: "maximum number of results to return", + required: false, + type: "integer", + format: "int32", + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + type: "array", + items: { + $ref: "#/definitions/Pet", + }, + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/ErrorModel", + }, + }, + }, + }, + post: { + description: "Creates a new pet in the store. Duplicates are allowed", + operationId: "addPet", + produces: ["application/json"], + parameters: [ + { + name: "pet", + in: "body", + description: "Pet to add to the store", + required: true, + schema: { + $ref: "#/definitions/NewPet", + }, + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + $ref: "#/definitions/Pet", + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/ErrorModel", + }, + }, + }, + }, + }, + "/pets/{id}": { + get: { + description: + "Returns a user based on a single ID, if the user does not have access to the pet", + operationId: "findPetById", + produces: ["application/json", "application/xml", "text/xml", "text/html"], + parameters: [ + { + name: "id", + in: "path", + description: "ID of pet to fetch", + required: true, + type: "integer", + format: "int64", + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + $ref: "#/definitions/Pet", + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/ErrorModel", + }, + }, + }, + }, + delete: { + description: "deletes a single pet based on the ID supplied", + operationId: "deletePet", + parameters: [ + { + name: "id", + in: "path", + description: "ID of pet to delete", + required: true, + type: "integer", + format: "int64", + }, + ], + responses: { + 204: { + description: "pet deleted", + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/ErrorModel", + }, + }, + }, + }, + }, + }, + definitions: { + Pet: { + type: "object", + allOf: [ + { + $ref: "#/definitions/NewPet", + }, + { + required: ["id"], + properties: { + id: { + type: "integer", + format: "int64", + }, + }, + }, + ], + }, + NewPet: { + type: "object", + required: ["name"], + properties: { + name: { + type: "string", + }, + tag: { + type: "string", + }, + }, + }, + ErrorModel: { + type: "object", + required: ["code", "message"], + properties: { + code: { + type: "integer", + format: "int32", + }, + message: { + type: "string", + }, + }, + }, + }, }; diff --git a/tests/2.0/petstore-with-external-docs.ts b/tests/2.0/petstore-with-external-docs.ts index f2deb9f..bf048ba 100644 --- a/tests/2.0/petstore-with-external-docs.ts +++ b/tests/2.0/petstore-with-external-docs.ts @@ -1,223 +1,212 @@ import type { Specification } from "../../2.0"; export const petstoreWithExternalDocs: Specification = { - swagger: "2.0", - info: { - version: "1.0.0", - title: "Swagger Petstore", - description: - "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", - termsOfService: "http://swagger.io/terms/", - contact: { - name: "Swagger API Team", - email: "apiteam@swagger.io", - url: "http://swagger.io", - }, - license: { - name: "Apache 2.0", - url: "https://www.apache.org/licenses/LICENSE-2.0.html", - }, - }, - externalDocs: { - description: "find more info here", - url: "https://swagger.io/about", - }, - host: "petstore.swagger.io", - basePath: "/api", - schemes: ["http"], - consumes: ["application/json"], - produces: ["application/json"], - paths: { - "/pets": { - get: { - description: - "Returns all pets from the system that the user has access to", - operationId: "findPets", - externalDocs: { - description: "find more info here", - url: "https://swagger.io/about", - }, - produces: [ - "application/json", - "application/xml", - "text/xml", - "text/html", - ], - parameters: [ - { - name: "tags", - in: "query", - description: "tags to filter by", - required: false, - type: "array", - items: { - type: "string", - }, - collectionFormat: "csv", - }, - { - name: "limit", - in: "query", - description: "maximum number of results to return", - required: false, - type: "integer", - format: "int32", - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - type: "array", - items: { - $ref: "#/definitions/Pet", - }, - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/ErrorModel", - }, - }, - }, - }, - post: { - description: "Creates a new pet in the store. Duplicates are allowed", - operationId: "addPet", - produces: ["application/json"], - parameters: [ - { - name: "pet", - in: "body", - description: "Pet to add to the store", - required: true, - schema: { - $ref: "#/definitions/NewPet", - }, - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - $ref: "#/definitions/Pet", - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/ErrorModel", - }, - }, - }, - }, - }, - "/pets/{id}": { - get: { - description: - "Returns a user based on a single ID, if the user does not have access to the pet", - operationId: "findPetById", - produces: [ - "application/json", - "application/xml", - "text/xml", - "text/html", - ], - parameters: [ - { - name: "id", - in: "path", - description: "ID of pet to fetch", - required: true, - type: "integer", - format: "int64", - }, - ], - responses: { - 200: { - description: "pet response", - schema: { - $ref: "#/definitions/Pet", - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/ErrorModel", - }, - }, - }, - }, - delete: { - description: "deletes a single pet based on the ID supplied", - operationId: "deletePet", - parameters: [ - { - name: "id", - in: "path", - description: "ID of pet to delete", - required: true, - type: "integer", - format: "int64", - }, - ], - responses: { - 204: { - description: "pet deleted", - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/ErrorModel", - }, - }, - }, - }, - }, - }, - definitions: { - Pet: { - type: "object", - allOf: [ - { - $ref: "#/definitions/NewPet", - }, - { - required: ["id"], - properties: { - id: { - type: "integer", - format: "int64", - }, - }, - }, - ], - }, - NewPet: { - type: "object", - required: ["name"], - properties: { - name: { - type: "string", - }, - tag: { - type: "string", - }, - }, - }, - ErrorModel: { - type: "object", - required: ["code", "message"], - properties: { - code: { - type: "integer", - format: "int32", - }, - message: { - type: "string", - }, - }, - }, - }, + swagger: "2.0", + info: { + version: "1.0.0", + title: "Swagger Petstore", + description: + "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification", + termsOfService: "http://swagger.io/terms/", + contact: { + name: "Swagger API Team", + email: "apiteam@swagger.io", + url: "http://swagger.io", + }, + license: { + name: "Apache 2.0", + url: "https://www.apache.org/licenses/LICENSE-2.0.html", + }, + }, + externalDocs: { + description: "find more info here", + url: "https://swagger.io/about", + }, + host: "petstore.swagger.io", + basePath: "/api", + schemes: ["http"], + consumes: ["application/json"], + produces: ["application/json"], + paths: { + "/pets": { + get: { + description: "Returns all pets from the system that the user has access to", + operationId: "findPets", + externalDocs: { + description: "find more info here", + url: "https://swagger.io/about", + }, + produces: ["application/json", "application/xml", "text/xml", "text/html"], + parameters: [ + { + name: "tags", + in: "query", + description: "tags to filter by", + required: false, + type: "array", + items: { + type: "string", + }, + collectionFormat: "csv", + }, + { + name: "limit", + in: "query", + description: "maximum number of results to return", + required: false, + type: "integer", + format: "int32", + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + type: "array", + items: { + $ref: "#/definitions/Pet", + }, + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/ErrorModel", + }, + }, + }, + }, + post: { + description: "Creates a new pet in the store. Duplicates are allowed", + operationId: "addPet", + produces: ["application/json"], + parameters: [ + { + name: "pet", + in: "body", + description: "Pet to add to the store", + required: true, + schema: { + $ref: "#/definitions/NewPet", + }, + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + $ref: "#/definitions/Pet", + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/ErrorModel", + }, + }, + }, + }, + }, + "/pets/{id}": { + get: { + description: + "Returns a user based on a single ID, if the user does not have access to the pet", + operationId: "findPetById", + produces: ["application/json", "application/xml", "text/xml", "text/html"], + parameters: [ + { + name: "id", + in: "path", + description: "ID of pet to fetch", + required: true, + type: "integer", + format: "int64", + }, + ], + responses: { + 200: { + description: "pet response", + schema: { + $ref: "#/definitions/Pet", + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/ErrorModel", + }, + }, + }, + }, + delete: { + description: "deletes a single pet based on the ID supplied", + operationId: "deletePet", + parameters: [ + { + name: "id", + in: "path", + description: "ID of pet to delete", + required: true, + type: "integer", + format: "int64", + }, + ], + responses: { + 204: { + description: "pet deleted", + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/ErrorModel", + }, + }, + }, + }, + }, + }, + definitions: { + Pet: { + type: "object", + allOf: [ + { + $ref: "#/definitions/NewPet", + }, + { + required: ["id"], + properties: { + id: { + type: "integer", + format: "int64", + }, + }, + }, + ], + }, + NewPet: { + type: "object", + required: ["name"], + properties: { + name: { + type: "string", + }, + tag: { + type: "string", + }, + }, + }, + ErrorModel: { + type: "object", + required: ["code", "message"], + properties: { + code: { + type: "integer", + format: "int32", + }, + message: { + type: "string", + }, + }, + }, + }, }; diff --git a/tests/2.0/petstore.ts b/tests/2.0/petstore.ts index 82e739c..48bb409 100644 --- a/tests/2.0/petstore.ts +++ b/tests/2.0/petstore.ts @@ -1,137 +1,137 @@ import type { Specification } from "../../2.0"; export const petstore: Specification = { - swagger: "2.0", - info: { - version: "1.0.0", - title: "Swagger Petstore", - license: { - name: "MIT", - }, - }, - host: "petstore.swagger.io", - basePath: "/v1", - schemes: ["http"], - consumes: ["application/json"], - produces: ["application/json"], - paths: { - "/pets": { - get: { - summary: "List all pets", - operationId: "listPets", - tags: ["pets"], - parameters: [ - { - name: "limit", - in: "query", - description: "How many items to return at one time (max 100)", - required: false, - type: "integer", - format: "int32", - }, - ], - responses: { - 200: { - description: "An paged array of pets", - headers: { - "x-next": { - type: "string", - description: "A link to the next page of responses", - }, - }, - schema: { - $ref: "#/definitions/Pets", - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - post: { - summary: "Create a pet", - operationId: "createPets", - tags: ["pets"], - responses: { - 201: { - description: "Null response", - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - "/pets/{petId}": { - get: { - summary: "Info for a specific pet", - operationId: "showPetById", - tags: ["pets"], - parameters: [ - { - name: "petId", - in: "path", - required: true, - description: "The id of the pet to retrieve", - type: "string", - }, - ], - responses: { - 200: { - description: "Expected response to a valid request", - schema: { - $ref: "#/definitions/Pets", - }, - }, - default: { - description: "unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - }, - definitions: { - Pet: { - required: ["id", "name"], - properties: { - id: { - type: "integer", - format: "int64", - }, - name: { - type: "string", - }, - tag: { - type: "string", - }, - }, - }, - Pets: { - type: "array", - items: { - $ref: "#/definitions/Pet", - }, - }, - Error: { - required: ["code", "message"], - properties: { - code: { - type: "integer", - format: "int32", - }, - message: { - type: "string", - }, - }, - }, - }, + swagger: "2.0", + info: { + version: "1.0.0", + title: "Swagger Petstore", + license: { + name: "MIT", + }, + }, + host: "petstore.swagger.io", + basePath: "/v1", + schemes: ["http"], + consumes: ["application/json"], + produces: ["application/json"], + paths: { + "/pets": { + get: { + summary: "List all pets", + operationId: "listPets", + tags: ["pets"], + parameters: [ + { + name: "limit", + in: "query", + description: "How many items to return at one time (max 100)", + required: false, + type: "integer", + format: "int32", + }, + ], + responses: { + 200: { + description: "An paged array of pets", + headers: { + "x-next": { + type: "string", + description: "A link to the next page of responses", + }, + }, + schema: { + $ref: "#/definitions/Pets", + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + post: { + summary: "Create a pet", + operationId: "createPets", + tags: ["pets"], + responses: { + 201: { + description: "Null response", + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + "/pets/{petId}": { + get: { + summary: "Info for a specific pet", + operationId: "showPetById", + tags: ["pets"], + parameters: [ + { + name: "petId", + in: "path", + required: true, + description: "The id of the pet to retrieve", + type: "string", + }, + ], + responses: { + 200: { + description: "Expected response to a valid request", + schema: { + $ref: "#/definitions/Pets", + }, + }, + default: { + description: "unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + }, + definitions: { + Pet: { + required: ["id", "name"], + properties: { + id: { + type: "integer", + format: "int64", + }, + name: { + type: "string", + }, + tag: { + type: "string", + }, + }, + }, + Pets: { + type: "array", + items: { + $ref: "#/definitions/Pet", + }, + }, + Error: { + required: ["code", "message"], + properties: { + code: { + type: "integer", + format: "int32", + }, + message: { + type: "string", + }, + }, + }, + }, }; diff --git a/tests/2.0/uber.ts b/tests/2.0/uber.ts index 954bf0c..ba33170 100644 --- a/tests/2.0/uber.ts +++ b/tests/2.0/uber.ts @@ -1,372 +1,368 @@ import type { Specification } from "../../2.0"; export const uber: Specification = { - swagger: "2.0", - info: { - title: "Uber API", - description: "Move your app forward with the Uber API", - version: "1.0.0", - }, - host: "api.uber.com", - schemes: ["https"], - basePath: "/v1", - produces: ["application/json"], - paths: { - "/products": { - get: { - summary: "Product Types", - description: - "The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.", - parameters: [ - { - name: "latitude", - in: "query", - description: "Latitude component of location.", - required: true, - type: "number", - format: "double", - }, - { - name: "longitude", - in: "query", - description: "Longitude component of location.", - required: true, - type: "number", - format: "double", - }, - ], - tags: ["Products"], - responses: { - 200: { - description: "An array of products", - schema: { - type: "array", - items: { - $ref: "#/definitions/Product", - }, - }, - }, - default: { - description: "Unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - "/estimates/price": { - get: { - summary: "Price Estimates", - description: - "The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol.

The response also includes low and high estimates, and the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for situations requiring currency conversion. When surge is active for a particular product, its surge_multiplier will be greater than 1, but the price estimate already factors in this multiplier.", - parameters: [ - { - name: "start_latitude", - in: "query", - description: "Latitude component of start location.", - required: true, - type: "number", - format: "double", - }, - { - name: "start_longitude", - in: "query", - description: "Longitude component of start location.", - required: true, - type: "number", - format: "double", - }, - { - name: "end_latitude", - in: "query", - description: "Latitude component of end location.", - required: true, - type: "number", - format: "double", - }, - { - name: "end_longitude", - in: "query", - description: "Longitude component of end location.", - required: true, - type: "number", - format: "double", - }, - ], - tags: ["Estimates"], - responses: { - 200: { - description: "An array of price estimates by product", - schema: { - type: "array", - items: { - $ref: "#/definitions/PriceEstimate", - }, - }, - }, - default: { - description: "Unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - "/estimates/time": { - get: { - summary: "Time Estimates", - description: - "The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.", - parameters: [ - { - name: "start_latitude", - in: "query", - description: "Latitude component of start location.", - required: true, - type: "number", - format: "double", - }, - { - name: "start_longitude", - in: "query", - description: "Longitude component of start location.", - required: true, - type: "number", - format: "double", - }, - { - name: "customer_uuid", - in: "query", - type: "string", - format: "uuid", - description: - "Unique customer identifier to be used for experience customization.", - }, - { - name: "product_id", - in: "query", - type: "string", - description: - "Unique identifier representing a specific product for a given latitude & longitude.", - }, - ], - tags: ["Estimates"], - responses: { - 200: { - description: "An array of products", - schema: { - type: "array", - items: { - $ref: "#/definitions/Product", - }, - }, - }, - default: { - description: "Unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - "/me": { - get: { - summary: "User Profile", - description: - "The User Profile endpoint returns information about the Uber user that has authorized with the application.", - tags: ["User"], - responses: { - 200: { - description: "Profile information for a user", - schema: { - $ref: "#/definitions/Profile", - }, - }, - default: { - description: "Unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - "/history": { - get: { - summary: "User Activity", - description: - "The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.

The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.", - parameters: [ - { - name: "offset", - in: "query", - type: "integer", - format: "int32", - description: - "Offset the list of returned results by this amount. Default is zero.", - }, - { - name: "limit", - in: "query", - type: "integer", - format: "int32", - description: - "Number of items to retrieve. Default is 5, maximum is 100.", - }, - ], - tags: ["User"], - responses: { - 200: { - description: "History information for the given user", - schema: { - $ref: "#/definitions/Activities", - }, - }, - default: { - description: "Unexpected error", - schema: { - $ref: "#/definitions/Error", - }, - }, - }, - }, - }, - }, - definitions: { - Product: { - properties: { - product_id: { - type: "string", - description: - "Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.", - }, - description: { - type: "string", - description: "Description of product.", - }, - display_name: { - type: "string", - description: "Display name of product.", - }, - capacity: { - type: "string", - description: "Capacity of product. For example, 4 people.", - }, - image: { - type: "string", - description: "Image URL representing the product.", - }, - }, - }, - PriceEstimate: { - properties: { - product_id: { - type: "string", - description: - "Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles", - }, - currency_code: { - type: "string", - description: - "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code.", - }, - display_name: { - type: "string", - description: "Display name of product.", - }, - estimate: { - type: "string", - description: - 'Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or "Metered" for TAXI.', - }, - low_estimate: { - type: "number", - description: "Lower bound of the estimated price.", - }, - high_estimate: { - type: "number", - description: "Upper bound of the estimated price.", - }, - surge_multiplier: { - type: "number", - description: - "Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier.", - }, - }, - }, - Profile: { - properties: { - first_name: { - type: "string", - description: "First name of the Uber user.", - }, - last_name: { - type: "string", - description: "Last name of the Uber user.", - }, - email: { - type: "string", - description: "Email address of the Uber user", - }, - picture: { - type: "string", - description: "Image URL of the Uber user.", - }, - promo_code: { - type: "string", - description: "Promo code of the Uber user.", - }, - }, - }, - Activity: { - properties: { - uuid: { - type: "string", - description: "Unique identifier for the activity", - }, - }, - }, - Activities: { - properties: { - offset: { - type: "integer", - format: "int32", - description: "Position in pagination.", - }, - limit: { - type: "integer", - format: "int32", - description: "Number of items to retrieve (100 max).", - }, - count: { - type: "integer", - format: "int32", - description: "Total number of items available.", - }, - history: { - type: "array", - items: { - $ref: "#/definitions/Activity", - }, - }, - }, - }, - Error: { - properties: { - code: { - type: "integer", - format: "int32", - }, - message: { - type: "string", - }, - fields: { - type: "string", - }, - }, - }, - }, + swagger: "2.0", + info: { + title: "Uber API", + description: "Move your app forward with the Uber API", + version: "1.0.0", + }, + host: "api.uber.com", + schemes: ["https"], + basePath: "/v1", + produces: ["application/json"], + paths: { + "/products": { + get: { + summary: "Product Types", + description: + "The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.", + parameters: [ + { + name: "latitude", + in: "query", + description: "Latitude component of location.", + required: true, + type: "number", + format: "double", + }, + { + name: "longitude", + in: "query", + description: "Longitude component of location.", + required: true, + type: "number", + format: "double", + }, + ], + tags: ["Products"], + responses: { + 200: { + description: "An array of products", + schema: { + type: "array", + items: { + $ref: "#/definitions/Product", + }, + }, + }, + default: { + description: "Unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + "/estimates/price": { + get: { + summary: "Price Estimates", + description: + "The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol.

The response also includes low and high estimates, and the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for situations requiring currency conversion. When surge is active for a particular product, its surge_multiplier will be greater than 1, but the price estimate already factors in this multiplier.", + parameters: [ + { + name: "start_latitude", + in: "query", + description: "Latitude component of start location.", + required: true, + type: "number", + format: "double", + }, + { + name: "start_longitude", + in: "query", + description: "Longitude component of start location.", + required: true, + type: "number", + format: "double", + }, + { + name: "end_latitude", + in: "query", + description: "Latitude component of end location.", + required: true, + type: "number", + format: "double", + }, + { + name: "end_longitude", + in: "query", + description: "Longitude component of end location.", + required: true, + type: "number", + format: "double", + }, + ], + tags: ["Estimates"], + responses: { + 200: { + description: "An array of price estimates by product", + schema: { + type: "array", + items: { + $ref: "#/definitions/PriceEstimate", + }, + }, + }, + default: { + description: "Unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + "/estimates/time": { + get: { + summary: "Time Estimates", + description: + "The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.", + parameters: [ + { + name: "start_latitude", + in: "query", + description: "Latitude component of start location.", + required: true, + type: "number", + format: "double", + }, + { + name: "start_longitude", + in: "query", + description: "Longitude component of start location.", + required: true, + type: "number", + format: "double", + }, + { + name: "customer_uuid", + in: "query", + type: "string", + format: "uuid", + description: "Unique customer identifier to be used for experience customization.", + }, + { + name: "product_id", + in: "query", + type: "string", + description: + "Unique identifier representing a specific product for a given latitude & longitude.", + }, + ], + tags: ["Estimates"], + responses: { + 200: { + description: "An array of products", + schema: { + type: "array", + items: { + $ref: "#/definitions/Product", + }, + }, + }, + default: { + description: "Unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + "/me": { + get: { + summary: "User Profile", + description: + "The User Profile endpoint returns information about the Uber user that has authorized with the application.", + tags: ["User"], + responses: { + 200: { + description: "Profile information for a user", + schema: { + $ref: "#/definitions/Profile", + }, + }, + default: { + description: "Unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + "/history": { + get: { + summary: "User Activity", + description: + "The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.

The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.", + parameters: [ + { + name: "offset", + in: "query", + type: "integer", + format: "int32", + description: "Offset the list of returned results by this amount. Default is zero.", + }, + { + name: "limit", + in: "query", + type: "integer", + format: "int32", + description: "Number of items to retrieve. Default is 5, maximum is 100.", + }, + ], + tags: ["User"], + responses: { + 200: { + description: "History information for the given user", + schema: { + $ref: "#/definitions/Activities", + }, + }, + default: { + description: "Unexpected error", + schema: { + $ref: "#/definitions/Error", + }, + }, + }, + }, + }, + }, + definitions: { + Product: { + properties: { + product_id: { + type: "string", + description: + "Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles.", + }, + description: { + type: "string", + description: "Description of product.", + }, + display_name: { + type: "string", + description: "Display name of product.", + }, + capacity: { + type: "string", + description: "Capacity of product. For example, 4 people.", + }, + image: { + type: "string", + description: "Image URL representing the product.", + }, + }, + }, + PriceEstimate: { + properties: { + product_id: { + type: "string", + description: + "Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles", + }, + currency_code: { + type: "string", + description: "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code.", + }, + display_name: { + type: "string", + description: "Display name of product.", + }, + estimate: { + type: "string", + description: + 'Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or "Metered" for TAXI.', + }, + low_estimate: { + type: "number", + description: "Lower bound of the estimated price.", + }, + high_estimate: { + type: "number", + description: "Upper bound of the estimated price.", + }, + surge_multiplier: { + type: "number", + description: + "Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier.", + }, + }, + }, + Profile: { + properties: { + first_name: { + type: "string", + description: "First name of the Uber user.", + }, + last_name: { + type: "string", + description: "Last name of the Uber user.", + }, + email: { + type: "string", + description: "Email address of the Uber user", + }, + picture: { + type: "string", + description: "Image URL of the Uber user.", + }, + promo_code: { + type: "string", + description: "Promo code of the Uber user.", + }, + }, + }, + Activity: { + properties: { + uuid: { + type: "string", + description: "Unique identifier for the activity", + }, + }, + }, + Activities: { + properties: { + offset: { + type: "integer", + format: "int32", + description: "Position in pagination.", + }, + limit: { + type: "integer", + format: "int32", + description: "Number of items to retrieve (100 max).", + }, + count: { + type: "integer", + format: "int32", + description: "Total number of items available.", + }, + history: { + type: "array", + items: { + $ref: "#/definitions/Activity", + }, + }, + }, + }, + Error: { + properties: { + code: { + type: "integer", + format: "int32", + }, + message: { + type: "string", + }, + fields: { + type: "string", + }, + }, + }, + }, }; diff --git a/tests/3.0/api-with-examples.ts b/tests/3.0/api-with-examples.ts index f87aa65..05d5fe1 100644 --- a/tests/3.0/api-with-examples.ts +++ b/tests/3.0/api-with-examples.ts @@ -1,194 +1,194 @@ import type { Specification } from "../../3.0"; export const apiWithExamples: Specification = { - openapi: "3.0.0", - info: { - title: "Simple API overview", - version: "2.0.0", - }, - paths: { - "/": { - get: { - operationId: "listVersionsv2", - summary: "List API versions", - responses: { - "200": { - description: "200 response", - content: { - "application/json": { - examples: { - foo: { - value: { - versions: [ - { - status: "CURRENT", - updated: "2011-01-21T11:33:21Z", - id: "v2.0", - links: [ - { - href: "http://127.0.0.1:8774/v2/", - rel: "self", - }, - ], - }, - { - status: "EXPERIMENTAL", - updated: "2013-07-23T11:33:21Z", - id: "v3.0", - links: [ - { - href: "http://127.0.0.1:8774/v3/", - rel: "self", - }, - ], - }, - ], - }, - }, - }, - }, - }, - }, - "300": { - description: "300 response", - content: { - "application/json": { - examples: { - foo: { - value: { - versions: [ - { - status: "CURRENT", - updated: "2011-01-21T11:33:21Z", - id: "v2.0", - links: [ - { - href: "http://127.0.0.1:8774/v2/", - rel: "self", - }, - ], - }, - { - status: "EXPERIMENTAL", - updated: "2013-07-23T11:33:21Z", - id: "v3.0", - links: [ - { - href: "http://127.0.0.1:8774/v3/", - rel: "self", - }, - ], - }, - ], - }, - }, - }, - }, - }, - }, - }, - }, - }, - "/v2": { - get: { - operationId: "getVersionDetailsv2", - summary: "Show API version details", - responses: { - "200": { - description: "200 response", - content: { - "application/json": { - examples: { - foo: { - value: { - version: { - status: "CURRENT", - updated: "2011-01-21T11:33:21Z", - "media-types": [ - { - base: "application/xml", - type: "application/vnd.openstack.compute+xml;version=2", - }, - { - base: "application/json", - type: "application/vnd.openstack.compute+json;version=2", - }, - ], - id: "v2.0", - links: [ - { - href: "http://127.0.0.1:8774/v2/", - rel: "self", - }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", - type: "application/pdf", - rel: "describedby", - }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", - type: "application/vnd.sun.wadl+xml", - rel: "describedby", - }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", - type: "application/vnd.sun.wadl+xml", - rel: "describedby", - }, - ], - }, - }, - }, - }, - }, - }, - }, - "203": { - description: "203 response", - content: { - "application/json": { - examples: { - foo: { - value: { - version: { - status: "CURRENT", - updated: "2011-01-21T11:33:21Z", - "media-types": [ - { - base: "application/xml", - type: "application/vnd.openstack.compute+xml;version=2", - }, - { - base: "application/json", - type: "application/vnd.openstack.compute+json;version=2", - }, - ], - id: "v2.0", - links: [ - { - href: "http://23.253.228.211:8774/v2/", - rel: "self", - }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", - type: "application/pdf", - rel: "describedby", - }, - { - href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", - type: "application/vnd.sun.wadl+xml", - rel: "describedby", - }, - ], - }, - }, - }, - }, - }, - }, - }, - }, - }, - }, - }, + openapi: "3.0.0", + info: { + title: "Simple API overview", + version: "2.0.0", + }, + paths: { + "/": { + get: { + operationId: "listVersionsv2", + summary: "List API versions", + responses: { + "200": { + description: "200 response", + content: { + "application/json": { + examples: { + foo: { + value: { + versions: [ + { + status: "CURRENT", + updated: "2011-01-21T11:33:21Z", + id: "v2.0", + links: [ + { + href: "http://127.0.0.1:8774/v2/", + rel: "self", + }, + ], + }, + { + status: "EXPERIMENTAL", + updated: "2013-07-23T11:33:21Z", + id: "v3.0", + links: [ + { + href: "http://127.0.0.1:8774/v3/", + rel: "self", + }, + ], + }, + ], + }, + }, + }, + }, + }, + }, + "300": { + description: "300 response", + content: { + "application/json": { + examples: { + foo: { + value: { + versions: [ + { + status: "CURRENT", + updated: "2011-01-21T11:33:21Z", + id: "v2.0", + links: [ + { + href: "http://127.0.0.1:8774/v2/", + rel: "self", + }, + ], + }, + { + status: "EXPERIMENTAL", + updated: "2013-07-23T11:33:21Z", + id: "v3.0", + links: [ + { + href: "http://127.0.0.1:8774/v3/", + rel: "self", + }, + ], + }, + ], + }, + }, + }, + }, + }, + }, + }, + }, + }, + "/v2": { + get: { + operationId: "getVersionDetailsv2", + summary: "Show API version details", + responses: { + "200": { + description: "200 response", + content: { + "application/json": { + examples: { + foo: { + value: { + version: { + status: "CURRENT", + updated: "2011-01-21T11:33:21Z", + "media-types": [ + { + base: "application/xml", + type: "application/vnd.openstack.compute+xml;version=2", + }, + { + base: "application/json", + type: "application/vnd.openstack.compute+json;version=2", + }, + ], + id: "v2.0", + links: [ + { + href: "http://127.0.0.1:8774/v2/", + rel: "self", + }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", + type: "application/pdf", + rel: "describedby", + }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", + type: "application/vnd.sun.wadl+xml", + rel: "describedby", + }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", + type: "application/vnd.sun.wadl+xml", + rel: "describedby", + }, + ], + }, + }, + }, + }, + }, + }, + }, + "203": { + description: "203 response", + content: { + "application/json": { + examples: { + foo: { + value: { + version: { + status: "CURRENT", + updated: "2011-01-21T11:33:21Z", + "media-types": [ + { + base: "application/xml", + type: "application/vnd.openstack.compute+xml;version=2", + }, + { + base: "application/json", + type: "application/vnd.openstack.compute+json;version=2", + }, + ], + id: "v2.0", + links: [ + { + href: "http://23.253.228.211:8774/v2/", + rel: "self", + }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", + type: "application/pdf", + rel: "describedby", + }, + { + href: "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", + type: "application/vnd.sun.wadl+xml", + rel: "describedby", + }, + ], + }, + }, + }, + }, + }, + }, + }, + }, + }, + }, + }, }; diff --git a/tests/3.0/callback-example.ts b/tests/3.0/callback-example.ts index 20b5453..df2666f 100644 --- a/tests/3.0/callback-example.ts +++ b/tests/3.0/callback-example.ts @@ -1,88 +1,87 @@ import type { Specification } from "../../3.0"; export const callbackExample: Specification = { - openapi: "3.0.0", - info: { - title: "Callback Example", - version: "1.0.0", - }, - paths: { - "/streams": { - post: { - description: "subscribes a client to receive out-of-band data", - parameters: [ - { - name: "callbackUrl", - in: "query", - required: true, - description: - "the location where data will be sent. Must be network accessible\nby the source server\n", - schema: { - type: "string", - format: "uri", - example: "https://tonys-server.com", - }, - }, - ], - responses: { - "201": { - description: "subscription successfully created", - content: { - "application/json": { - schema: { - description: "subscription information", - required: ["subscriptionId"], - properties: { - subscriptionId: { - description: - "this unique identifier allows management of the subscription", - type: "string", - example: "2531329f-fb09-4ef7-887e-84e648214436", - }, - }, - }, - }, - }, - }, - }, - callbacks: { - onData: { - "{$request.query.callbackUrl}/data": { - post: { - requestBody: { - description: "subscription payload", - content: { - "application/json": { - schema: { - type: "object", - properties: { - timestamp: { - type: "string", - format: "date-time", - }, - userData: { - type: "string", - }, - }, - }, - }, - }, - }, - responses: { - "202": { - description: - "Your server implementation should return this HTTP status code\nif the data was received successfully\n", - }, - "204": { - description: - "Your server should return this HTTP status code if no longer interested\nin further updates\n", - }, - }, - }, - }, - }, - }, - }, - }, - }, + openapi: "3.0.0", + info: { + title: "Callback Example", + version: "1.0.0", + }, + paths: { + "/streams": { + post: { + description: "subscribes a client to receive out-of-band data", + parameters: [ + { + name: "callbackUrl", + in: "query", + required: true, + description: + "the location where data will be sent. Must be network accessible\nby the source server\n", + schema: { + type: "string", + format: "uri", + example: "https://tonys-server.com", + }, + }, + ], + responses: { + "201": { + description: "subscription successfully created", + content: { + "application/json": { + schema: { + description: "subscription information", + required: ["subscriptionId"], + properties: { + subscriptionId: { + description: "this unique identifier allows management of the subscription", + type: "string", + example: "2531329f-fb09-4ef7-887e-84e648214436", + }, + }, + }, + }, + }, + }, + }, + callbacks: { + onData: { + "{$request.query.callbackUrl}/data": { + post: { + requestBody: { + description: "subscription payload", + content: { + "application/json": { + schema: { + type: "object", + properties: { + timestamp: { + type: "string", + format: "date-time", + }, + userData: { + type: "string", + }, + }, + }, + }, + }, + }, + responses: { + "202": { + description: + "Your server implementation should return this HTTP status code\nif the data was received successfully\n", + }, + "204": { + description: + "Your server should return this HTTP status code if no longer interested\nin further updates\n", + }, + }, + }, + }, + }, + }, + }, + }, + }, }; diff --git a/tests/3.0/link-example.ts b/tests/3.0/link-example.ts index 199c4e7..fac16e4 100644 --- a/tests/3.0/link-example.ts +++ b/tests/3.0/link-example.ts @@ -1,321 +1,321 @@ import type { Specification } from "../../3.0"; export const linkExample: Specification = { - openapi: "3.0.0", - info: { - title: "Link Example", - version: "1.0.0", - }, - paths: { - "/2.0/users/{username}": { - get: { - operationId: "getUserByName", - parameters: [ - { - name: "username", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - ], - responses: { - "200": { - description: "The User", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/user", - }, - }, - }, - links: { - userRepositories: { - $ref: "#/components/links/UserRepositories", - }, - }, - }, - }, - }, - }, - "/2.0/repositories/{username}": { - get: { - operationId: "getRepositoriesByOwner", - parameters: [ - { - name: "username", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - ], - responses: { - "200": { - description: "repositories owned by the supplied user", - content: { - "application/json": { - schema: { - type: "array", - items: { - $ref: "#/components/schemas/repository", - }, - }, - }, - }, - links: { - userRepository: { - $ref: "#/components/links/UserRepository", - }, - }, - }, - }, - }, - }, - "/2.0/repositories/{username}/{slug}": { - get: { - operationId: "getRepository", - parameters: [ - { - name: "username", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - { - name: "slug", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - ], - responses: { - "200": { - description: "The repository", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/repository", - }, - }, - }, - links: { - repositoryPullRequests: { - $ref: "#/components/links/RepositoryPullRequests", - }, - }, - }, - }, - }, - }, - "/2.0/repositories/{username}/{slug}/pullrequests": { - get: { - operationId: "getPullRequestsByRepository", - parameters: [ - { - name: "username", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - { - name: "slug", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - { - name: "state", - in: "query", - schema: { - type: "string", - enum: ["open", "merged", "declined"], - }, - }, - ], - responses: { - "200": { - description: "an array of pull request objects", - content: { - "application/json": { - schema: { - type: "array", - items: { - $ref: "#/components/schemas/pullrequest", - }, - }, - }, - }, - }, - }, - }, - }, - "/2.0/repositories/{username}/{slug}/pullrequests/{pid}": { - get: { - operationId: "getPullRequestsById", - parameters: [ - { - name: "username", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - { - name: "slug", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - { - name: "pid", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - ], - responses: { - "200": { - description: "a pull request object", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/pullrequest", - }, - }, - }, - links: { - pullRequestMerge: { - $ref: "#/components/links/PullRequestMerge", - }, - }, - }, - }, - }, - }, - "/2.0/repositories/{username}/{slug}/pullrequests/{pid}/merge": { - post: { - operationId: "mergePullRequest", - parameters: [ - { - name: "username", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - { - name: "slug", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - { - name: "pid", - in: "path", - required: true, - schema: { - type: "string", - }, - }, - ], - responses: { - "204": { - description: "the PR was successfully merged", - }, - }, - }, - }, - }, - components: { - links: { - UserRepositories: { - operationId: "getRepositoriesByOwner", - parameters: { - username: "$response.body#/username", - }, - }, - UserRepository: { - operationId: "getRepository", - parameters: { - username: "$response.body#/owner/username", - slug: "$response.body#/slug", - }, - }, - RepositoryPullRequests: { - operationId: "getPullRequestsByRepository", - parameters: { - username: "$response.body#/owner/username", - slug: "$response.body#/slug", - }, - }, - PullRequestMerge: { - operationId: "mergePullRequest", - parameters: { - username: "$response.body#/author/username", - slug: "$response.body#/repository/slug", - pid: "$response.body#/id", - }, - }, - }, - schemas: { - user: { - type: "object", - properties: { - username: { - type: "string", - }, - uuid: { - type: "string", - }, - }, - }, - repository: { - type: "object", - properties: { - slug: { - type: "string", - }, - owner: { - $ref: "#/components/schemas/user", - }, - }, - }, - pullrequest: { - type: "object", - properties: { - id: { - type: "integer", - }, - title: { - type: "string", - }, - repository: { - $ref: "#/components/schemas/repository", - }, - author: { - $ref: "#/components/schemas/user", - }, - }, - }, - }, - }, + openapi: "3.0.0", + info: { + title: "Link Example", + version: "1.0.0", + }, + paths: { + "/2.0/users/{username}": { + get: { + operationId: "getUserByName", + parameters: [ + { + name: "username", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + responses: { + "200": { + description: "The User", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/user", + }, + }, + }, + links: { + userRepositories: { + $ref: "#/components/links/UserRepositories", + }, + }, + }, + }, + }, + }, + "/2.0/repositories/{username}": { + get: { + operationId: "getRepositoriesByOwner", + parameters: [ + { + name: "username", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + responses: { + "200": { + description: "repositories owned by the supplied user", + content: { + "application/json": { + schema: { + type: "array", + items: { + $ref: "#/components/schemas/repository", + }, + }, + }, + }, + links: { + userRepository: { + $ref: "#/components/links/UserRepository", + }, + }, + }, + }, + }, + }, + "/2.0/repositories/{username}/{slug}": { + get: { + operationId: "getRepository", + parameters: [ + { + name: "username", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "slug", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + responses: { + "200": { + description: "The repository", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/repository", + }, + }, + }, + links: { + repositoryPullRequests: { + $ref: "#/components/links/RepositoryPullRequests", + }, + }, + }, + }, + }, + }, + "/2.0/repositories/{username}/{slug}/pullrequests": { + get: { + operationId: "getPullRequestsByRepository", + parameters: [ + { + name: "username", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "slug", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "state", + in: "query", + schema: { + type: "string", + enum: ["open", "merged", "declined"], + }, + }, + ], + responses: { + "200": { + description: "an array of pull request objects", + content: { + "application/json": { + schema: { + type: "array", + items: { + $ref: "#/components/schemas/pullrequest", + }, + }, + }, + }, + }, + }, + }, + }, + "/2.0/repositories/{username}/{slug}/pullrequests/{pid}": { + get: { + operationId: "getPullRequestsById", + parameters: [ + { + name: "username", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "slug", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pid", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + responses: { + "200": { + description: "a pull request object", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/pullrequest", + }, + }, + }, + links: { + pullRequestMerge: { + $ref: "#/components/links/PullRequestMerge", + }, + }, + }, + }, + }, + }, + "/2.0/repositories/{username}/{slug}/pullrequests/{pid}/merge": { + post: { + operationId: "mergePullRequest", + parameters: [ + { + name: "username", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "slug", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + { + name: "pid", + in: "path", + required: true, + schema: { + type: "string", + }, + }, + ], + responses: { + "204": { + description: "the PR was successfully merged", + }, + }, + }, + }, + }, + components: { + links: { + UserRepositories: { + operationId: "getRepositoriesByOwner", + parameters: { + username: "$response.body#/username", + }, + }, + UserRepository: { + operationId: "getRepository", + parameters: { + username: "$response.body#/owner/username", + slug: "$response.body#/slug", + }, + }, + RepositoryPullRequests: { + operationId: "getPullRequestsByRepository", + parameters: { + username: "$response.body#/owner/username", + slug: "$response.body#/slug", + }, + }, + PullRequestMerge: { + operationId: "mergePullRequest", + parameters: { + username: "$response.body#/author/username", + slug: "$response.body#/repository/slug", + pid: "$response.body#/id", + }, + }, + }, + schemas: { + user: { + type: "object", + properties: { + username: { + type: "string", + }, + uuid: { + type: "string", + }, + }, + }, + repository: { + type: "object", + properties: { + slug: { + type: "string", + }, + owner: { + $ref: "#/components/schemas/user", + }, + }, + }, + pullrequest: { + type: "object", + properties: { + id: { + type: "integer", + }, + title: { + type: "string", + }, + repository: { + $ref: "#/components/schemas/repository", + }, + author: { + $ref: "#/components/schemas/user", + }, + }, + }, + }, + }, }; diff --git a/tests/3.0/petstore-expanded.ts b/tests/3.0/petstore-expanded.ts index 5cf0c97..bde0800 100644 --- a/tests/3.0/petstore-expanded.ts +++ b/tests/3.0/petstore-expanded.ts @@ -1,240 +1,240 @@ import type { Specification } from "../../3.0"; export const petstoreExpanded: Specification = { - openapi: "3.0.0", - info: { - version: "1.0.0", - title: "Swagger Petstore", - description: - "A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification", - termsOfService: "http://swagger.io/terms/", - contact: { - name: "Swagger API Team", - email: "apiteam@swagger.io", - url: "http://swagger.io", - }, - license: { - name: "Apache 2.0", - url: "https://www.apache.org/licenses/LICENSE-2.0.html", - }, - }, - servers: [ - { - url: "https://petstore.swagger.io/v2", - }, - ], - paths: { - "/pets": { - get: { - description: - "Returns all pets from the system that the user has access to\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\n\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\n", - operationId: "findPets", - parameters: [ - { - name: "tags", - in: "query", - description: "tags to filter by", - required: false, - style: "form", - schema: { - type: "array", - items: { - type: "string", - }, - }, - }, - { - name: "limit", - in: "query", - description: "maximum number of results to return", - required: false, - schema: { - type: "integer", - format: "int32", - }, - }, - ], - responses: { - "200": { - description: "pet response", - content: { - "application/json": { - schema: { - type: "array", - items: { - $ref: "#/components/schemas/Pet", - }, - }, - }, - }, - }, - default: { - description: "unexpected error", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Error", - }, - }, - }, - }, - }, - }, - post: { - description: "Creates a new pet in the store. Duplicates are allowed", - operationId: "addPet", - requestBody: { - description: "Pet to add to the store", - required: true, - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/NewPet", - }, - }, - }, - }, - responses: { - "200": { - description: "pet response", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Pet", - }, - }, - }, - }, - default: { - description: "unexpected error", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Error", - }, - }, - }, - }, - }, - }, - }, - "/pets/{id}": { - get: { - description: - "Returns a user based on a single ID, if the user does not have access to the pet", - operationId: "find pet by id", - parameters: [ - { - name: "id", - in: "path", - description: "ID of pet to fetch", - required: true, - schema: { - type: "integer", - format: "int64", - }, - }, - ], - responses: { - "200": { - description: "pet response", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Pet", - }, - }, - }, - }, - default: { - description: "unexpected error", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Error", - }, - }, - }, - }, - }, - }, - delete: { - description: "deletes a single pet based on the ID supplied", - operationId: "deletePet", - parameters: [ - { - name: "id", - in: "path", - description: "ID of pet to delete", - required: true, - schema: { - type: "integer", - format: "int64", - }, - }, - ], - responses: { - "204": { - description: "pet deleted", - }, - default: { - description: "unexpected error", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Error", - }, - }, - }, - }, - }, - }, - }, - }, - components: { - schemas: { - Pet: { - allOf: [ - { - $ref: "#/components/schemas/NewPet", - }, - { - type: "object", - required: ["id"], - properties: { - id: { - type: "integer", - format: "int64", - }, - }, - }, - ], - }, - NewPet: { - type: "object", - required: ["name"], - properties: { - name: { - type: "string", - }, - tag: { - type: "string", - }, - }, - }, - Error: { - type: "object", - required: ["code", "message"], - properties: { - code: { - type: "integer", - format: "int32", - }, - message: { - type: "string", - }, - }, - }, - }, - }, + openapi: "3.0.0", + info: { + version: "1.0.0", + title: "Swagger Petstore", + description: + "A sample API that uses a petstore as an example to demonstrate features in the OpenAPI 3.0 specification", + termsOfService: "http://swagger.io/terms/", + contact: { + name: "Swagger API Team", + email: "apiteam@swagger.io", + url: "http://swagger.io", + }, + license: { + name: "Apache 2.0", + url: "https://www.apache.org/licenses/LICENSE-2.0.html", + }, + }, + servers: [ + { + url: "https://petstore.swagger.io/v2", + }, + ], + paths: { + "/pets": { + get: { + description: + "Returns all pets from the system that the user has access to\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\n\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\n", + operationId: "findPets", + parameters: [ + { + name: "tags", + in: "query", + description: "tags to filter by", + required: false, + style: "form", + schema: { + type: "array", + items: { + type: "string", + }, + }, + }, + { + name: "limit", + in: "query", + description: "maximum number of results to return", + required: false, + schema: { + type: "integer", + format: "int32", + }, + }, + ], + responses: { + "200": { + description: "pet response", + content: { + "application/json": { + schema: { + type: "array", + items: { + $ref: "#/components/schemas/Pet", + }, + }, + }, + }, + }, + default: { + description: "unexpected error", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Error", + }, + }, + }, + }, + }, + }, + post: { + description: "Creates a new pet in the store. Duplicates are allowed", + operationId: "addPet", + requestBody: { + description: "Pet to add to the store", + required: true, + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/NewPet", + }, + }, + }, + }, + responses: { + "200": { + description: "pet response", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Pet", + }, + }, + }, + }, + default: { + description: "unexpected error", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Error", + }, + }, + }, + }, + }, + }, + }, + "/pets/{id}": { + get: { + description: + "Returns a user based on a single ID, if the user does not have access to the pet", + operationId: "find pet by id", + parameters: [ + { + name: "id", + in: "path", + description: "ID of pet to fetch", + required: true, + schema: { + type: "integer", + format: "int64", + }, + }, + ], + responses: { + "200": { + description: "pet response", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Pet", + }, + }, + }, + }, + default: { + description: "unexpected error", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Error", + }, + }, + }, + }, + }, + }, + delete: { + description: "deletes a single pet based on the ID supplied", + operationId: "deletePet", + parameters: [ + { + name: "id", + in: "path", + description: "ID of pet to delete", + required: true, + schema: { + type: "integer", + format: "int64", + }, + }, + ], + responses: { + "204": { + description: "pet deleted", + }, + default: { + description: "unexpected error", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Error", + }, + }, + }, + }, + }, + }, + }, + }, + components: { + schemas: { + Pet: { + allOf: [ + { + $ref: "#/components/schemas/NewPet", + }, + { + type: "object", + required: ["id"], + properties: { + id: { + type: "integer", + format: "int64", + }, + }, + }, + ], + }, + NewPet: { + type: "object", + required: ["name"], + properties: { + name: { + type: "string", + }, + tag: { + type: "string", + }, + }, + }, + Error: { + type: "object", + required: ["code", "message"], + properties: { + code: { + type: "integer", + format: "int32", + }, + message: { + type: "string", + }, + }, + }, + }, + }, }; diff --git a/tests/3.0/petstore.ts b/tests/3.0/petstore.ts index 529dcb8..d9ed4ec 100644 --- a/tests/3.0/petstore.ts +++ b/tests/3.0/petstore.ts @@ -1,179 +1,179 @@ import type { Specification } from "../../3.0"; export const petstore: Specification = { - openapi: "3.0.0", - info: { - version: "1.0.0", - title: "Swagger Petstore", - license: { - name: "MIT", - }, - }, - servers: [ - { - url: "http://petstore.swagger.io/v1", - }, - ], - paths: { - "/pets": { - get: { - summary: "List all pets", - operationId: "listPets", - tags: ["pets"], - parameters: [ - { - name: "limit", - in: "query", - description: "How many items to return at one time (max 100)", - required: false, - schema: { - type: "integer", - maximum: 100, - format: "int32", - }, - }, - ], - responses: { - "200": { - description: "A paged array of pets", - headers: { - "x-next": { - description: "A link to the next page of responses", - schema: { - type: "string", - }, - }, - }, - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Pets", - }, - }, - }, - }, - default: { - description: "unexpected error", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Error", - }, - }, - }, - }, - }, - }, - post: { - summary: "Create a pet", - operationId: "createPets", - tags: ["pets"], - requestBody: { - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Pet", - }, - }, - }, - required: true, - }, - responses: { - "201": { - description: "Null response", - }, - default: { - description: "unexpected error", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Error", - }, - }, - }, - }, - }, - }, - }, - "/pets/{petId}": { - get: { - summary: "Info for a specific pet", - operationId: "showPetById", - tags: ["pets"], - parameters: [ - { - name: "petId", - in: "path", - required: true, - description: "The id of the pet to retrieve", - schema: { - type: "string", - }, - }, - ], - responses: { - "200": { - description: "Expected response to a valid request", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Pet", - }, - }, - }, - }, - default: { - description: "unexpected error", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Error", - }, - }, - }, - }, - }, - }, - }, - }, - components: { - schemas: { - Pet: { - type: "object", - required: ["id", "name"], - properties: { - id: { - type: "integer", - format: "int64", - }, - name: { - type: "string", - }, - tag: { - type: "string", - }, - }, - }, - Pets: { - type: "array", - maxItems: 100, - items: { - $ref: "#/components/schemas/Pet", - }, - }, - Error: { - type: "object", - required: ["code", "message"], - properties: { - code: { - type: "integer", - format: "int32", - }, - message: { - type: "string", - }, - }, - }, - }, - }, + openapi: "3.0.0", + info: { + version: "1.0.0", + title: "Swagger Petstore", + license: { + name: "MIT", + }, + }, + servers: [ + { + url: "http://petstore.swagger.io/v1", + }, + ], + paths: { + "/pets": { + get: { + summary: "List all pets", + operationId: "listPets", + tags: ["pets"], + parameters: [ + { + name: "limit", + in: "query", + description: "How many items to return at one time (max 100)", + required: false, + schema: { + type: "integer", + maximum: 100, + format: "int32", + }, + }, + ], + responses: { + "200": { + description: "A paged array of pets", + headers: { + "x-next": { + description: "A link to the next page of responses", + schema: { + type: "string", + }, + }, + }, + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Pets", + }, + }, + }, + }, + default: { + description: "unexpected error", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Error", + }, + }, + }, + }, + }, + }, + post: { + summary: "Create a pet", + operationId: "createPets", + tags: ["pets"], + requestBody: { + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Pet", + }, + }, + }, + required: true, + }, + responses: { + "201": { + description: "Null response", + }, + default: { + description: "unexpected error", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Error", + }, + }, + }, + }, + }, + }, + }, + "/pets/{petId}": { + get: { + summary: "Info for a specific pet", + operationId: "showPetById", + tags: ["pets"], + parameters: [ + { + name: "petId", + in: "path", + required: true, + description: "The id of the pet to retrieve", + schema: { + type: "string", + }, + }, + ], + responses: { + "200": { + description: "Expected response to a valid request", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Pet", + }, + }, + }, + }, + default: { + description: "unexpected error", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Error", + }, + }, + }, + }, + }, + }, + }, + }, + components: { + schemas: { + Pet: { + type: "object", + required: ["id", "name"], + properties: { + id: { + type: "integer", + format: "int64", + }, + name: { + type: "string", + }, + tag: { + type: "string", + }, + }, + }, + Pets: { + type: "array", + maxItems: 100, + items: { + $ref: "#/components/schemas/Pet", + }, + }, + Error: { + type: "object", + required: ["code", "message"], + properties: { + code: { + type: "integer", + format: "int32", + }, + message: { + type: "string", + }, + }, + }, + }, + }, }; diff --git a/tests/3.0/uspto.ts b/tests/3.0/uspto.ts index 8c431af..233631e 100644 --- a/tests/3.0/uspto.ts +++ b/tests/3.0/uspto.ts @@ -1,257 +1,253 @@ import type { Specification } from "../../3.0"; export const uspto: Specification = { - openapi: "3.0.1", - servers: [ - { - url: "{scheme}://developer.uspto.gov/ds-api", - variables: { - scheme: { - description: "The Data Set API is accessible via https and http", - enum: ["https", "http"], - default: "https", - }, - }, - }, - ], - info: { - description: - "The Data Set API (DSAPI) allows the public users to discover and search USPTO exported data sets. This is a generic API that allows USPTO users to make any CSV based data files searchable through API. With the help of GET call, it returns the list of data fields that are searchable. With the help of POST call, data can be fetched based on the filters on the field names. Please note that POST call is used to search the actual data. The reason for the POST call is that it allows users to specify any complex search criteria without worry about the GET size limitations as well as encoding of the input parameters.", - version: "1.0.0", - title: "USPTO Data Set API", - contact: { - name: "Open Data Portal", - url: "https://developer.uspto.gov", - email: "developer@uspto.gov", - }, - }, - tags: [ - { - name: "metadata", - description: "Find out about the data sets", - }, - { - name: "search", - description: "Search a data set", - }, - ], - paths: { - "/": { - get: { - tags: ["metadata"], - operationId: "list-data-sets", - summary: "List available data sets", - responses: { - "200": { - description: "Returns a list of data sets", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/dataSetList", - }, - example: { - total: 2, - apis: [ - { - apiKey: "oa_citations", - apiVersionNumber: "v1", - apiUrl: - "https://developer.uspto.gov/ds-api/oa_citations/v1/fields", - apiDocumentationUrl: - "https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/oa_citations.json", - }, - { - apiKey: "cancer_moonshot", - apiVersionNumber: "v1", - apiUrl: - "https://developer.uspto.gov/ds-api/cancer_moonshot/v1/fields", - apiDocumentationUrl: - "https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/cancer_moonshot.json", - }, - ], - }, - }, - }, - }, - }, - }, - }, - "/{dataset}/{version}/fields": { - get: { - tags: ["metadata"], - summary: - "Provides the general information about the API and the list of fields that can be used to query the dataset.", - description: - "This GET API returns the list of all the searchable field names that are in the oa_citations. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.", - operationId: "list-searchable-fields", - parameters: [ - { - name: "dataset", - in: "path", - description: "Name of the dataset.", - required: true, - example: "oa_citations", - schema: { - type: "string", - }, - }, - { - name: "version", - in: "path", - description: "Version of the dataset.", - required: true, - example: "v1", - schema: { - type: "string", - }, - }, - ], - responses: { - "200": { - description: - "The dataset API for the given version is found and it is accessible to consume.", - content: { - "application/json": { - schema: { - type: "string", - }, - }, - }, - }, - "404": { - description: - "The combination of dataset name and version is not found in the system or it is not published yet to be consumed by public.", - content: { - "application/json": { - schema: { - type: "string", - }, - }, - }, - }, - }, - }, - }, - "/{dataset}/{version}/records": { - post: { - tags: ["search"], - summary: - "Provides search capability for the data set with the given search criteria.", - description: - "This API is based on Solr/Lucene Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api.", - operationId: "perform-search", - parameters: [ - { - name: "version", - in: "path", - description: "Version of the dataset.", - required: true, - schema: { - type: "string", - default: "v1", - }, - }, - { - name: "dataset", - in: "path", - description: - "Name of the dataset. In this case, the default value is oa_citations", - required: true, - schema: { - type: "string", - default: "oa_citations", - }, - }, - ], - responses: { - "200": { - description: "successful operation", - content: { - "application/json": { - schema: { - type: "array", - items: { - type: "object", - additionalProperties: { - type: "object", - }, - }, - }, - }, - }, - }, - "404": { - description: "No matching record found for the given criteria.", - }, - }, - requestBody: { - content: { - "application/x-www-form-urlencoded": { - schema: { - type: "object", - properties: { - criteria: { - description: - "Uses Lucene Query Syntax in the format of propertyName:value, propertyName:[num1 TO num2] and date range format: propertyName:[yyyyMMdd TO yyyyMMdd]. In the response please see the 'docs' element which has the list of record objects. Each record structure would consist of all the fields and their corresponding values.", - type: "string", - default: "*:*", - }, - start: { - description: "Starting record number. Default value is 0.", - type: "integer", - default: 0, - }, - rows: { - description: - "Specify number of rows to be returned. If you run the search with default values, in the response you will see 'numFound' attribute which will tell the number of records available in the dataset.", - type: "integer", - default: 100, - }, - }, - required: ["criteria"], - }, - }, - }, - }, - }, - }, - }, - components: { - schemas: { - dataSetList: { - type: "object", - properties: { - total: { - type: "integer", - }, - apis: { - type: "array", - items: { - type: "object", - properties: { - apiKey: { - type: "string", - description: "To be used as a dataset parameter value", - }, - apiVersionNumber: { - type: "string", - description: "To be used as a version parameter value", - }, - apiUrl: { - type: "string", - format: "uriref", - description: "The URL describing the dataset's fields", - }, - apiDocumentationUrl: { - type: "string", - format: "uriref", - description: "A URL to the API console for each API", - }, - }, - }, - }, - }, - }, - }, - }, + openapi: "3.0.1", + servers: [ + { + url: "{scheme}://developer.uspto.gov/ds-api", + variables: { + scheme: { + description: "The Data Set API is accessible via https and http", + enum: ["https", "http"], + default: "https", + }, + }, + }, + ], + info: { + description: + "The Data Set API (DSAPI) allows the public users to discover and search USPTO exported data sets. This is a generic API that allows USPTO users to make any CSV based data files searchable through API. With the help of GET call, it returns the list of data fields that are searchable. With the help of POST call, data can be fetched based on the filters on the field names. Please note that POST call is used to search the actual data. The reason for the POST call is that it allows users to specify any complex search criteria without worry about the GET size limitations as well as encoding of the input parameters.", + version: "1.0.0", + title: "USPTO Data Set API", + contact: { + name: "Open Data Portal", + url: "https://developer.uspto.gov", + email: "developer@uspto.gov", + }, + }, + tags: [ + { + name: "metadata", + description: "Find out about the data sets", + }, + { + name: "search", + description: "Search a data set", + }, + ], + paths: { + "/": { + get: { + tags: ["metadata"], + operationId: "list-data-sets", + summary: "List available data sets", + responses: { + "200": { + description: "Returns a list of data sets", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/dataSetList", + }, + example: { + total: 2, + apis: [ + { + apiKey: "oa_citations", + apiVersionNumber: "v1", + apiUrl: "https://developer.uspto.gov/ds-api/oa_citations/v1/fields", + apiDocumentationUrl: + "https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/oa_citations.json", + }, + { + apiKey: "cancer_moonshot", + apiVersionNumber: "v1", + apiUrl: "https://developer.uspto.gov/ds-api/cancer_moonshot/v1/fields", + apiDocumentationUrl: + "https://developer.uspto.gov/ds-api-docs/index.html?url=https://developer.uspto.gov/ds-api/swagger/docs/cancer_moonshot.json", + }, + ], + }, + }, + }, + }, + }, + }, + }, + "/{dataset}/{version}/fields": { + get: { + tags: ["metadata"], + summary: + "Provides the general information about the API and the list of fields that can be used to query the dataset.", + description: + "This GET API returns the list of all the searchable field names that are in the oa_citations. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the syntax options shown below.", + operationId: "list-searchable-fields", + parameters: [ + { + name: "dataset", + in: "path", + description: "Name of the dataset.", + required: true, + example: "oa_citations", + schema: { + type: "string", + }, + }, + { + name: "version", + in: "path", + description: "Version of the dataset.", + required: true, + example: "v1", + schema: { + type: "string", + }, + }, + ], + responses: { + "200": { + description: + "The dataset API for the given version is found and it is accessible to consume.", + content: { + "application/json": { + schema: { + type: "string", + }, + }, + }, + }, + "404": { + description: + "The combination of dataset name and version is not found in the system or it is not published yet to be consumed by public.", + content: { + "application/json": { + schema: { + type: "string", + }, + }, + }, + }, + }, + }, + }, + "/{dataset}/{version}/records": { + post: { + tags: ["search"], + summary: "Provides search capability for the data set with the given search criteria.", + description: + "This API is based on Solr/Lucene Search. The data is indexed using SOLR. This GET API returns the list of all the searchable field names that are in the Solr Index. Please see the 'fields' attribute which returns an array of field names. Each field or a combination of fields can be searched using the Solr/Lucene Syntax. Please refer https://lucene.apache.org/core/3_6_2/queryparsersyntax.html#Overview for the query syntax. List of field names that are searchable can be determined using above GET api.", + operationId: "perform-search", + parameters: [ + { + name: "version", + in: "path", + description: "Version of the dataset.", + required: true, + schema: { + type: "string", + default: "v1", + }, + }, + { + name: "dataset", + in: "path", + description: "Name of the dataset. In this case, the default value is oa_citations", + required: true, + schema: { + type: "string", + default: "oa_citations", + }, + }, + ], + responses: { + "200": { + description: "successful operation", + content: { + "application/json": { + schema: { + type: "array", + items: { + type: "object", + additionalProperties: { + type: "object", + }, + }, + }, + }, + }, + }, + "404": { + description: "No matching record found for the given criteria.", + }, + }, + requestBody: { + content: { + "application/x-www-form-urlencoded": { + schema: { + type: "object", + properties: { + criteria: { + description: + "Uses Lucene Query Syntax in the format of propertyName:value, propertyName:[num1 TO num2] and date range format: propertyName:[yyyyMMdd TO yyyyMMdd]. In the response please see the 'docs' element which has the list of record objects. Each record structure would consist of all the fields and their corresponding values.", + type: "string", + default: "*:*", + }, + start: { + description: "Starting record number. Default value is 0.", + type: "integer", + default: 0, + }, + rows: { + description: + "Specify number of rows to be returned. If you run the search with default values, in the response you will see 'numFound' attribute which will tell the number of records available in the dataset.", + type: "integer", + default: 100, + }, + }, + required: ["criteria"], + }, + }, + }, + }, + }, + }, + }, + components: { + schemas: { + dataSetList: { + type: "object", + properties: { + total: { + type: "integer", + }, + apis: { + type: "array", + items: { + type: "object", + properties: { + apiKey: { + type: "string", + description: "To be used as a dataset parameter value", + }, + apiVersionNumber: { + type: "string", + description: "To be used as a version parameter value", + }, + apiUrl: { + type: "string", + format: "uriref", + description: "The URL describing the dataset's fields", + }, + apiDocumentationUrl: { + type: "string", + format: "uriref", + description: "A URL to the API console for each API", + }, + }, + }, + }, + }, + }, + }, + }, }; diff --git a/tests/3.1/non-oauth-scopes.ts b/tests/3.1/non-oauth-scopes.ts index a486cd2..70a8ad7 100644 --- a/tests/3.1/non-oauth-scopes.ts +++ b/tests/3.1/non-oauth-scopes.ts @@ -1,34 +1,33 @@ import type { Specification } from "../../3.1"; export const nonOauthScopes: Specification = { - openapi: "3.1.0", - info: { - title: "Non-oAuth Scopes example", - version: "1.0.0", - }, - paths: { - "/users": { - //@ts-expect-error This is an example specification from OpenAPI, - // it seems to intentionally not conform to the specification, - // as its meant to be a minimal example. - get: { - security: [ - { - bearerAuth: ["read:users", "public"], - }, - ], - }, - }, - }, - components: { - securitySchemes: { - bearerAuth: { - type: "http", - scheme: "bearer", - bearerFormat: "jwt", - description: - "note: non-oauth scopes are not defined at the securityScheme level", - }, - }, - }, + openapi: "3.1.0", + info: { + title: "Non-oAuth Scopes example", + version: "1.0.0", + }, + paths: { + "/users": { + //@ts-expect-error This is an example specification from OpenAPI, + // it seems to intentionally not conform to the specification, + // as its meant to be a minimal example. + get: { + security: [ + { + bearerAuth: ["read:users", "public"], + }, + ], + }, + }, + }, + components: { + securitySchemes: { + bearerAuth: { + type: "http", + scheme: "bearer", + bearerFormat: "jwt", + description: "note: non-oauth scopes are not defined at the securityScheme level", + }, + }, + }, }; diff --git a/tests/3.1/tictactoe.ts b/tests/3.1/tictactoe.ts index ddf8e6a..727795f 100644 --- a/tests/3.1/tictactoe.ts +++ b/tests/3.1/tictactoe.ts @@ -1,266 +1,265 @@ import type { Specification } from "../../3.1"; export const tictactoe: Specification = { - openapi: "3.1.0", - info: { - title: "Tic Tac Toe", - description: - "This API allows writing down marks on a Tic Tac Toe board\nand requesting the state of the board or of individual squares.\n", - version: "1.0.0", - }, - tags: [ - { - name: "Gameplay", - }, - ], - paths: { - "/board": { - get: { - summary: "Get the whole board", - description: "Retrieves the current state of the board and the winner.", - tags: ["Gameplay"], - operationId: "get-board", - responses: { - "200": { - description: "OK", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/status", - }, - }, - }, - }, - }, - security: [ - { - defaultApiKey: [], - }, - { - app2AppOauth: ["board:read"], - }, - ], - }, - }, - "/board/{row}/{column}": { - parameters: [ - { - $ref: "#/components/parameters/rowParam", - }, - { - $ref: "#/components/parameters/columnParam", - }, - ], - get: { - summary: "Get a single board square", - description: "Retrieves the requested square.", - tags: ["Gameplay"], - operationId: "get-square", - responses: { - "200": { - description: "OK", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/mark", - }, - }, - }, - }, - "400": { - description: "The provided parameters are incorrect", - content: { - "text/html": { - schema: { - $ref: "#/components/schemas/errorMessage", - }, - example: "Illegal coordinates", - }, - }, - }, - }, - security: [ - { - bearerHttpAuthentication: [], - }, - { - user2AppOauth: ["board:read"], - }, - ], - }, - put: { - summary: "Set a single board square", - description: - "Places a mark on the board and retrieves the whole board and the winner (if any).", - tags: ["Gameplay"], - operationId: "put-square", - requestBody: { - required: true, - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/mark", - }, - }, - }, - }, - responses: { - "200": { - description: "OK", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/status", - }, - }, - }, - }, - "400": { - description: "The provided parameters are incorrect", - content: { - "text/html": { - schema: { - $ref: "#/components/schemas/errorMessage", - }, - examples: { - illegalCoordinates: { - value: "Illegal coordinates.", - }, - notEmpty: { - value: "Square is not empty.", - }, - invalidMark: { - value: "Invalid Mark (X or O).", - }, - }, - }, - }, - }, - }, - security: [ - { - bearerHttpAuthentication: [], - }, - { - user2AppOauth: ["board:write"], - }, - ], - }, - }, - }, - components: { - parameters: { - rowParam: { - description: "Board row (vertical coordinate)", - name: "row", - in: "path", - required: true, - schema: { - $ref: "#/components/schemas/coordinate", - }, - }, - columnParam: { - description: "Board column (horizontal coordinate)", - name: "column", - in: "path", - required: true, - schema: { - $ref: "#/components/schemas/coordinate", - }, - }, - }, - schemas: { - errorMessage: { - type: "string", - maxLength: 256, - description: "A text message describing an error", - }, - coordinate: { - type: "integer", - minimum: 1, - maximum: 3, - example: 1, - }, - mark: { - type: "string", - enum: [".", "X", "O"], - description: - "Possible values for a board square. `.` means empty square.", - example: ".", - }, - board: { - type: "array", - maxItems: 3, - minItems: 3, - items: { - type: "array", - maxItems: 3, - minItems: 3, - items: { - $ref: "#/components/schemas/mark", - }, - }, - }, - winner: { - type: "string", - enum: [".", "X", "O"], - description: "Winner of the game. `.` means nobody has won yet.", - example: ".", - }, - status: { - type: "object", - properties: { - winner: { - $ref: "#/components/schemas/winner", - }, - board: { - $ref: "#/components/schemas/board", - }, - }, - }, - }, - securitySchemes: { - defaultApiKey: { - description: "API key provided in console", - type: "apiKey", - name: "api-key", - in: "header", - }, - basicHttpAuthentication: { - description: "Basic HTTP Authentication", - type: "http", - scheme: "Basic", - }, - bearerHttpAuthentication: { - description: "Bearer token using a JWT", - type: "http", - scheme: "Bearer", - bearerFormat: "JWT", - }, - app2AppOauth: { - type: "oauth2", - flows: { - clientCredentials: { - tokenUrl: "https://learn.openapis.org/oauth/2.0/token", - scopes: { - "board:read": "Read the board", - }, - }, - }, - }, - user2AppOauth: { - type: "oauth2", - flows: { - authorizationCode: { - authorizationUrl: "https://learn.openapis.org/oauth/2.0/auth", - tokenUrl: "https://learn.openapis.org/oauth/2.0/token", - scopes: { - "board:read": "Read the board", - "board:write": "Write to the board", - }, - }, - }, - }, - }, - }, + openapi: "3.1.0", + info: { + title: "Tic Tac Toe", + description: + "This API allows writing down marks on a Tic Tac Toe board\nand requesting the state of the board or of individual squares.\n", + version: "1.0.0", + }, + tags: [ + { + name: "Gameplay", + }, + ], + paths: { + "/board": { + get: { + summary: "Get the whole board", + description: "Retrieves the current state of the board and the winner.", + tags: ["Gameplay"], + operationId: "get-board", + responses: { + "200": { + description: "OK", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/status", + }, + }, + }, + }, + }, + security: [ + { + defaultApiKey: [], + }, + { + app2AppOauth: ["board:read"], + }, + ], + }, + }, + "/board/{row}/{column}": { + parameters: [ + { + $ref: "#/components/parameters/rowParam", + }, + { + $ref: "#/components/parameters/columnParam", + }, + ], + get: { + summary: "Get a single board square", + description: "Retrieves the requested square.", + tags: ["Gameplay"], + operationId: "get-square", + responses: { + "200": { + description: "OK", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/mark", + }, + }, + }, + }, + "400": { + description: "The provided parameters are incorrect", + content: { + "text/html": { + schema: { + $ref: "#/components/schemas/errorMessage", + }, + example: "Illegal coordinates", + }, + }, + }, + }, + security: [ + { + bearerHttpAuthentication: [], + }, + { + user2AppOauth: ["board:read"], + }, + ], + }, + put: { + summary: "Set a single board square", + description: + "Places a mark on the board and retrieves the whole board and the winner (if any).", + tags: ["Gameplay"], + operationId: "put-square", + requestBody: { + required: true, + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/mark", + }, + }, + }, + }, + responses: { + "200": { + description: "OK", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/status", + }, + }, + }, + }, + "400": { + description: "The provided parameters are incorrect", + content: { + "text/html": { + schema: { + $ref: "#/components/schemas/errorMessage", + }, + examples: { + illegalCoordinates: { + value: "Illegal coordinates.", + }, + notEmpty: { + value: "Square is not empty.", + }, + invalidMark: { + value: "Invalid Mark (X or O).", + }, + }, + }, + }, + }, + }, + security: [ + { + bearerHttpAuthentication: [], + }, + { + user2AppOauth: ["board:write"], + }, + ], + }, + }, + }, + components: { + parameters: { + rowParam: { + description: "Board row (vertical coordinate)", + name: "row", + in: "path", + required: true, + schema: { + $ref: "#/components/schemas/coordinate", + }, + }, + columnParam: { + description: "Board column (horizontal coordinate)", + name: "column", + in: "path", + required: true, + schema: { + $ref: "#/components/schemas/coordinate", + }, + }, + }, + schemas: { + errorMessage: { + type: "string", + maxLength: 256, + description: "A text message describing an error", + }, + coordinate: { + type: "integer", + minimum: 1, + maximum: 3, + example: 1, + }, + mark: { + type: "string", + enum: [".", "X", "O"], + description: "Possible values for a board square. `.` means empty square.", + example: ".", + }, + board: { + type: "array", + maxItems: 3, + minItems: 3, + items: { + type: "array", + maxItems: 3, + minItems: 3, + items: { + $ref: "#/components/schemas/mark", + }, + }, + }, + winner: { + type: "string", + enum: [".", "X", "O"], + description: "Winner of the game. `.` means nobody has won yet.", + example: ".", + }, + status: { + type: "object", + properties: { + winner: { + $ref: "#/components/schemas/winner", + }, + board: { + $ref: "#/components/schemas/board", + }, + }, + }, + }, + securitySchemes: { + defaultApiKey: { + description: "API key provided in console", + type: "apiKey", + name: "api-key", + in: "header", + }, + basicHttpAuthentication: { + description: "Basic HTTP Authentication", + type: "http", + scheme: "Basic", + }, + bearerHttpAuthentication: { + description: "Bearer token using a JWT", + type: "http", + scheme: "Bearer", + bearerFormat: "JWT", + }, + app2AppOauth: { + type: "oauth2", + flows: { + clientCredentials: { + tokenUrl: "https://learn.openapis.org/oauth/2.0/token", + scopes: { + "board:read": "Read the board", + }, + }, + }, + }, + user2AppOauth: { + type: "oauth2", + flows: { + authorizationCode: { + authorizationUrl: "https://learn.openapis.org/oauth/2.0/auth", + tokenUrl: "https://learn.openapis.org/oauth/2.0/token", + scopes: { + "board:read": "Read the board", + "board:write": "Write to the board", + }, + }, + }, + }, + }, + }, }; diff --git a/tests/3.1/webhook-example.ts b/tests/3.1/webhook-example.ts index a39b56f..ca845a0 100644 --- a/tests/3.1/webhook-example.ts +++ b/tests/3.1/webhook-example.ts @@ -1,50 +1,49 @@ import type { Specification } from "../../3.1"; export const webhookExample: Specification = { - openapi: "3.1.0", - info: { - title: "Webhook Example", - version: "1.0.0", - }, - webhooks: { - newPet: { - post: { - requestBody: { - description: "Information about a new pet in the system", - content: { - "application/json": { - schema: { - $ref: "#/components/schemas/Pet", - }, - }, - }, - }, - responses: { - "200": { - description: - "Return a 200 status to indicate that the data was received successfully", - }, - }, - }, - }, - }, - components: { - schemas: { - Pet: { - required: ["id", "name"], - properties: { - id: { - type: "integer", - format: "int64", - }, - name: { - type: "string", - }, - tag: { - type: "string", - }, - }, - }, - }, - }, + openapi: "3.1.0", + info: { + title: "Webhook Example", + version: "1.0.0", + }, + webhooks: { + newPet: { + post: { + requestBody: { + description: "Information about a new pet in the system", + content: { + "application/json": { + schema: { + $ref: "#/components/schemas/Pet", + }, + }, + }, + }, + responses: { + "200": { + description: "Return a 200 status to indicate that the data was received successfully", + }, + }, + }, + }, + }, + components: { + schemas: { + Pet: { + required: ["id", "name"], + properties: { + id: { + type: "integer", + format: "int64", + }, + name: { + type: "string", + }, + tag: { + type: "string", + }, + }, + }, + }, + }, }; diff --git a/tests/openapi-3.0-schemas.test.ts b/tests/openapi-3.0-schemas.test.ts index 652d437..7ff7fc8 100644 --- a/tests/openapi-3.0-schemas.test.ts +++ b/tests/openapi-3.0-schemas.test.ts @@ -17,9 +17,7 @@ const ajv = new Ajv({ strict: false, }); -const schema: JSONSchemaType = JSON.parse( - JSON.stringify(schemas.specification) -); +const schema: JSONSchemaType = JSON.parse(JSON.stringify(schemas.specification)); // validate is a type guard for Specification - type is inferred from schema type const validate = ajv.compile(schema); @@ -74,7 +72,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { it("should have valid servers array when present", () => { if (spec.servers) { expect(Array.isArray(spec.servers)).toBe(true); - spec.servers.forEach((server) => { + spec.servers.forEach(server => { expect(server.url).toBeDefined(); expect(typeof server.url).toBe("string"); }); @@ -90,7 +88,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { return { name, isValid, errors: validate.errors }; }); - const failedSpecs = results.filter((result) => !result.isValid); + const failedSpecs = results.filter(result => !result.isValid); if (failedSpecs.length > 0) { console.error("Failed specifications:"); @@ -107,7 +105,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { const uniqueVersions = [...new Set(versions)]; expect(uniqueVersions.length).toBeGreaterThan(0); - uniqueVersions.forEach((version) => { + uniqueVersions.forEach(version => { expect(version).toMatch(/^3\.0\.\d+$/); }); }); @@ -115,7 +113,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { it("should have valid server URLs when present", () => { specsToTest.forEach(({ name, spec }) => { if (spec.servers) { - spec.servers.forEach((server) => { + spec.servers.forEach(server => { // Server URL should be a valid URL format expect(server.url).toMatch(/^https?:\/\/|^\/|^\{/); }); @@ -126,10 +124,10 @@ describe("OpenAPI 3.0 Schema Validation", () => { it("should have valid server variables when present", () => { specsToTest.forEach(({ name, spec }) => { if (spec.servers) { - spec.servers.forEach((server) => { + spec.servers.forEach(server => { if (server.variables) { expect(typeof server.variables).toBe("object"); - Object.values(server.variables).forEach((variable) => { + Object.values(server.variables).forEach(variable => { expect(variable).toHaveProperty("default"); }); } @@ -142,7 +140,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { specsToTest.forEach(({ name, spec }) => { if (spec.tags) { expect(Array.isArray(spec.tags)).toBe(true); - spec.tags.forEach((tag) => { + spec.tags.forEach(tag => { expect(tag.name).toBeDefined(); expect(typeof tag.name).toBe("string"); }); @@ -154,14 +152,12 @@ describe("OpenAPI 3.0 Schema Validation", () => { specsToTest.forEach(({ name, spec }) => { if (spec.components?.securitySchemes) { expect(typeof spec.components.securitySchemes).toBe("object"); - Object.values(spec.components.securitySchemes).forEach((scheme) => { + Object.values(spec.components.securitySchemes).forEach(scheme => { // Type guard to check if it's not a Reference if (!("$ref" in scheme)) { expect(scheme).toHaveProperty("type"); expect(scheme.type).toBeDefined(); - expect(["apiKey", "http", "oauth2", "openIdConnect"]).toContain( - scheme.type - ); + expect(["apiKey", "http", "oauth2", "openIdConnect"]).toContain(scheme.type); } }); } @@ -189,12 +185,10 @@ describe("OpenAPI 3.0 Schema Validation", () => { // Check for specific error about openapi version const hasOpenApiVersionError = validate.errors?.some( - (error) => + error => error.instancePath === "/openapi" && (error.message?.includes("must be equal to constant") || - error.message?.includes( - "must be equal to one of the allowed values" - ) || + error.message?.includes("must be equal to one of the allowed values") || error.message?.includes("must match pattern")) ); expect(hasOpenApiVersionError).toBe(true); @@ -211,14 +205,11 @@ describe("OpenAPI 3.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); // Print actual errors for debugging - console.log( - "Missing required fields validation errors:", - validate.errors - ); + console.log("Missing required fields validation errors:", validate.errors); // Check for specific required field error const hasRequiredError = validate.errors?.some( - (error) => + error => error.keyword === "required" && error.instancePath === "" && error.message?.includes("must have required property 'info'") @@ -310,7 +301,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -361,7 +352,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -408,7 +399,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -450,7 +441,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -646,7 +637,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -688,7 +679,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -747,17 +738,14 @@ describe("OpenAPI 3.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); // Print actual errors for debugging - console.log( - "Detailed error messages validation errors:", - validate.errors - ); + console.log("Detailed error messages validation errors:", validate.errors); // Check that error messages are descriptive const errors = validate.errors || []; expect(errors.length).toBeGreaterThan(0); // Verify error structure - errors.forEach((error) => { + errors.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); // AJV uses 'instancePath' instead of 'dataPath' in newer versions @@ -766,7 +754,7 @@ describe("OpenAPI 3.0 Schema Validation", () => { // Check for specific missing version error const hasVersionError = validate.errors?.some( - (error) => + error => error.keyword === "required" && error.instancePath === "/info" && error.message?.includes("must have required property 'version'") diff --git a/tests/openapi-3.1-schemas.test.ts b/tests/openapi-3.1-schemas.test.ts index 9dc2b5c..6bc8fed 100644 --- a/tests/openapi-3.1-schemas.test.ts +++ b/tests/openapi-3.1-schemas.test.ts @@ -14,9 +14,7 @@ const ajv = new Ajv({ strict: false, }); -const schema: JSONSchemaType = JSON.parse( - JSON.stringify(schemas.specification) -); +const schema: JSONSchemaType = JSON.parse(JSON.stringify(schemas.specification)); // validate is a type guard for Specification - type is inferred from schema type const validate = ajv.compile(schema); @@ -33,9 +31,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { describe(name, () => { it("should be a valid OpenAPI 3.1 specification", () => { if (skipValidation) { - console.log( - `Skipping validation for ${name} (intentionally incomplete example)` - ); + console.log(`Skipping validation for ${name} (intentionally incomplete example)`); expect(true).toBe(true); // Pass the test return; } @@ -76,7 +72,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { it("should have valid servers array when present", () => { if (spec.servers) { expect(Array.isArray(spec.servers)).toBe(true); - spec.servers.forEach((server) => { + spec.servers.forEach(server => { expect(server.url).toBeDefined(); expect(typeof server.url).toBe("string"); }); @@ -102,7 +98,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { return { name, isValid, errors: validate.errors }; }); - const failedSpecs = results.filter((result) => !result.isValid); + const failedSpecs = results.filter(result => !result.isValid); if (failedSpecs.length > 0) { console.error("Failed specifications:"); @@ -119,7 +115,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { const uniqueVersions = [...new Set(versions)]; expect(uniqueVersions.length).toBeGreaterThan(0); - uniqueVersions.forEach((version) => { + uniqueVersions.forEach(version => { expect(version).toMatch(/^3\.1\.\d+$/); }); }); @@ -127,7 +123,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { it("should have valid server URLs when present", () => { specsToTest.forEach(({ name, spec }) => { if (spec.servers) { - spec.servers.forEach((server) => { + spec.servers.forEach(server => { // Server URL should be a valid URL format expect(server.url).toMatch(/^https?:\/\/|^\/|^\{/); }); @@ -138,10 +134,10 @@ describe("OpenAPI 3.1 Schema Validation", () => { it("should have valid server variables when present", () => { specsToTest.forEach(({ name, spec }) => { if (spec.servers) { - spec.servers.forEach((server) => { + spec.servers.forEach(server => { if (server.variables) { expect(typeof server.variables).toBe("object"); - Object.values(server.variables).forEach((variable) => { + Object.values(server.variables).forEach(variable => { expect(variable).toHaveProperty("default"); }); } @@ -154,7 +150,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { specsToTest.forEach(({ name, spec }) => { if (spec.tags) { expect(Array.isArray(spec.tags)).toBe(true); - spec.tags.forEach((tag) => { + spec.tags.forEach(tag => { expect(tag.name).toBeDefined(); expect(typeof tag.name).toBe("string"); }); @@ -166,13 +162,11 @@ describe("OpenAPI 3.1 Schema Validation", () => { specsToTest.forEach(({ name, spec }) => { if (spec.components?.securitySchemes) { expect(typeof spec.components.securitySchemes).toBe("object"); - Object.values(spec.components.securitySchemes).forEach((scheme) => { + Object.values(spec.components.securitySchemes).forEach(scheme => { // Type guard to check if it's not a Reference if (!("$ref" in scheme)) { expect(scheme.type).toBeDefined(); - expect(["apiKey", "http", "oauth2", "openIdConnect"]).toContain( - scheme.type - ); + expect(["apiKey", "http", "oauth2", "openIdConnect"]).toContain(scheme.type); } }); } @@ -182,7 +176,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { it("should have valid webhook operations when present", () => { specsToTest.forEach(({ name, spec }) => { if (spec.webhooks) { - Object.values(spec.webhooks).forEach((webhook) => { + Object.values(spec.webhooks).forEach(webhook => { // Type guard to check if it's not a Reference if (!("$ref" in webhook)) { expect(webhook).toHaveProperty("post"); @@ -196,15 +190,11 @@ describe("OpenAPI 3.1 Schema Validation", () => { it("should have valid OAuth2 flows when present", () => { specsToTest.forEach(({ name, spec }) => { if (spec.components?.securitySchemes) { - Object.values(spec.components.securitySchemes).forEach((scheme) => { + Object.values(spec.components.securitySchemes).forEach(scheme => { // Type guard to check if it's not a Reference - if ( - !("$ref" in scheme) && - scheme.type === "oauth2" && - scheme.flows - ) { + if (!("$ref" in scheme) && scheme.type === "oauth2" && scheme.flows) { expect(typeof scheme.flows).toBe("object"); - Object.values(scheme.flows).forEach((flow) => { + Object.values(scheme.flows).forEach(flow => { expect(flow).toHaveProperty("scopes"); expect(typeof flow.scopes).toBe("object"); }); @@ -236,18 +226,16 @@ describe("OpenAPI 3.1 Schema Validation", () => { // Check for specific error about openapi version const hasOpenApiVersionError = validate.errors?.some( - (error) => + error => error.instancePath === "/openapi" && (error.message?.includes("must be equal to constant") || - error.message?.includes( - "must be equal to one of the allowed values" - ) || + error.message?.includes("must be equal to one of the allowed values") || error.message?.includes("must match pattern")) ); expect(hasOpenApiVersionError).toBe(true); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -268,14 +256,11 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); // Print actual errors for debugging - console.log( - "Missing required fields validation errors:", - validate.errors - ); + console.log("Missing required fields validation errors:", validate.errors); // Check for specific required field error const hasRequiredError = validate.errors?.some( - (error) => + error => error.keyword === "required" && error.instancePath === "" && error.message?.includes("must have required property 'info'") @@ -600,7 +585,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -637,7 +622,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -747,7 +732,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -806,7 +791,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -848,7 +833,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -876,7 +861,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -905,7 +890,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -946,7 +931,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -976,7 +961,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); expect(validate.errors?.length).toBeGreaterThan(0); // Verify error structure when validation fails - validate.errors?.forEach((error) => { + validate.errors?.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); }); @@ -1021,17 +1006,14 @@ describe("OpenAPI 3.1 Schema Validation", () => { expect(validate.errors).toBeDefined(); // Print actual errors for debugging - console.log( - "Detailed error messages validation errors:", - validate.errors - ); + console.log("Detailed error messages validation errors:", validate.errors); // Check that error messages are descriptive const errors = validate.errors || []; expect(errors.length).toBeGreaterThan(0); // Verify error structure - errors.forEach((error) => { + errors.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); // AJV uses 'instancePath' instead of 'dataPath' in newer versions @@ -1040,7 +1022,7 @@ describe("OpenAPI 3.1 Schema Validation", () => { // Check for specific missing version error const hasVersionError = validate.errors?.some( - (error) => + error => error.keyword === "required" && error.instancePath === "/info" && error.message?.includes("must have required property 'version'") diff --git a/tests/swagger-schemas.test.ts b/tests/swagger-schemas.test.ts index 97e5327..3316571 100755 --- a/tests/swagger-schemas.test.ts +++ b/tests/swagger-schemas.test.ts @@ -18,9 +18,7 @@ const ajv = new Ajv({ strict: false, }); -const schema: JSONSchemaType = JSON.parse( - JSON.stringify(schemas.specification) -); +const schema: JSONSchemaType = JSON.parse(JSON.stringify(schemas.specification)); // validate is a type guard for Specification - type is inferred from schema type const validate = ajv.compile(schema); @@ -82,7 +80,7 @@ describe("Swagger 2.0 Schema Validation", () => { return { name, isValid, errors: validate.errors }; }); - const failedSpecs = results.filter((result) => !result.isValid); + const failedSpecs = results.filter(result => !result.isValid); if (failedSpecs.length > 0) { console.error("Failed specifications:"); @@ -154,12 +152,10 @@ describe("Swagger 2.0 Schema Validation", () => { // Check for specific error about swagger version const hasSwaggerVersionError = validate.errors?.some( - (error) => + error => error.instancePath === "/swagger" && (error.message?.includes("must be equal to constant") || - error.message?.includes( - "must be equal to one of the allowed values" - )) + error.message?.includes("must be equal to one of the allowed values")) ); expect(hasSwaggerVersionError).toBe(true); }); @@ -175,14 +171,11 @@ describe("Swagger 2.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); // Print actual errors for debugging - console.log( - "Missing required fields validation errors:", - validate.errors - ); + console.log("Missing required fields validation errors:", validate.errors); // Check for specific required field error const hasRequiredError = validate.errors?.some( - (error) => + error => error.keyword === "required" && error.instancePath === "" && error.message?.includes("must have required property 'info'") @@ -204,20 +197,17 @@ describe("Swagger 2.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); // Print actual errors for debugging - console.log( - "Invalid info object structure validation errors:", - validate.errors - ); + console.log("Invalid info object structure validation errors:", validate.errors); // Check for specific missing required fields in info const hasTitleError = validate.errors?.some( - (error) => + error => error.keyword === "required" && error.instancePath === "/info" && error.message?.includes("must have required property 'title'") ); const hasVersionError = validate.errors?.some( - (error) => + error => error.keyword === "required" && error.instancePath === "/info" && error.message?.includes("must have required property 'version'") @@ -245,7 +235,7 @@ describe("Swagger 2.0 Schema Validation", () => { // Check for specific host format error or missing paths error (since host validation might not be strict) const hasHostFormatError = validate.errors?.some( - (error) => + error => error.instancePath === "/host" && (error.message?.includes("must not match") || error.message?.includes("must match") || @@ -253,7 +243,7 @@ describe("Swagger 2.0 Schema Validation", () => { ); // If no specific host format error, check for missing paths error (which is the main validation failure) const hasMissingPathsError = validate.errors?.some( - (error) => + error => error.instancePath === "" && error.message?.includes("must have required property 'paths'") ); @@ -564,17 +554,14 @@ describe("Swagger 2.0 Schema Validation", () => { expect(validate.errors).toBeDefined(); // Print actual errors for debugging - console.log( - "Detailed error messages validation errors:", - validate.errors - ); + console.log("Detailed error messages validation errors:", validate.errors); // Check that error messages are descriptive const errors = validate.errors || []; expect(errors.length).toBeGreaterThan(0); // Verify error structure - errors.forEach((error) => { + errors.forEach(error => { expect(error).toHaveProperty("keyword"); expect(error).toHaveProperty("message"); // AJV uses 'instancePath' instead of 'dataPath' in newer versions @@ -583,7 +570,7 @@ describe("Swagger 2.0 Schema Validation", () => { // Check for specific missing version error const hasVersionError = validate.errors?.some( - (error) => + error => error.keyword === "required" && error.instancePath === "/info" && error.message?.includes("must have required property 'version'") diff --git a/tsconfig.json b/tsconfig.json index 2a931b7..b9f1db3 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,31 +1,31 @@ { - "compilerOptions": { - // Environment setup & latest features - "lib": ["ESNext"], - "target": "ESNext", - "module": "Preserve", - "moduleDetection": "force", - "jsx": "react-jsx", - "allowJs": true, + "compilerOptions": { + // Environment setup & latest features + "lib": ["ESNext"], + "target": "ESNext", + "module": "Preserve", + "moduleDetection": "force", + "jsx": "react-jsx", + "allowJs": true, - // Bundler mode - "moduleResolution": "bundler", - "allowImportingTsExtensions": true, - "verbatimModuleSyntax": true, - "noEmit": true, + // Bundler mode + "moduleResolution": "bundler", + "allowImportingTsExtensions": true, + "verbatimModuleSyntax": true, + "noEmit": true, - // Best practices - "strict": true, - "skipLibCheck": true, - "noFallthroughCasesInSwitch": true, - "forceConsistentCasingInFileNames": true, - "noUncheckedIndexedAccess": true, - "noImplicitOverride": true, - "esModuleInterop": true, + // Best practices + "strict": true, + "skipLibCheck": true, + "noFallthroughCasesInSwitch": true, + "forceConsistentCasingInFileNames": true, + "noUncheckedIndexedAccess": true, + "noImplicitOverride": true, + "esModuleInterop": true, - // Some stricter flags (disabled by default) - "noUnusedLocals": false, - "noUnusedParameters": false, - "noPropertyAccessFromIndexSignature": false - } + // Some stricter flags (disabled by default) + "noUnusedLocals": false, + "noUnusedParameters": false, + "noPropertyAccessFromIndexSignature": false + } }